Revision: 14999
http://gate.svn.sourceforge.net/gate/?rev=14999&view=rev
Author: markagreenwood
Date: 2012-01-10 20:12:24 +0000 (Tue, 10 Jan 2012)
Log Message:
-----------
more javadoc fixes
Modified Paths:
--------------
gate/trunk/src/gate/creole/annic/HTMLGenerator.java
gate/trunk/src/gate/creole/annic/Hit.java
gate/trunk/src/gate/creole/annic/Indexer.java
gate/trunk/src/gate/creole/annic/Parser.java
gate/trunk/src/gate/creole/annic/Pattern.java
gate/trunk/src/gate/creole/annic/PatternAnnotation.java
gate/trunk/src/gate/creole/annic/Searchable.java
gate/trunk/src/gate/creole/annic/Searcher.java
Modified: gate/trunk/src/gate/creole/annic/HTMLGenerator.java
===================================================================
--- gate/trunk/src/gate/creole/annic/HTMLGenerator.java 2012-01-10 20:04:45 UTC
(rev 14998)
+++ gate/trunk/src/gate/creole/annic/HTMLGenerator.java 2012-01-10 20:12:24 UTC
(rev 14999)
@@ -22,9 +22,6 @@
* This method exports the annic pattern to HTML. The HTML provides a
* way to look at various annotations that span across the found annic
* pattern.
- *
- * @param pattern
- * @return
*/
public static String generateHTMLTable(Pattern pattern) {
PatternAnnotation[] patternAnnotations = pattern.getPatternAnnotations();
Modified: gate/trunk/src/gate/creole/annic/Hit.java
===================================================================
--- gate/trunk/src/gate/creole/annic/Hit.java 2012-01-10 20:04:45 UTC (rev
14998)
+++ gate/trunk/src/gate/creole/annic/Hit.java 2012-01-10 20:12:24 UTC (rev
14999)
@@ -65,8 +65,6 @@
/**
* Returns the start offset of the matching part (query matched part)
- *
- * @return
*/
public int getStartOffset() {
return startOffset;
@@ -74,8 +72,6 @@
/**
* Returns the end offset of the matching part (query matched part)
- *
- * @return
*/
public int getEndOffset() {
return endOffset;
@@ -83,8 +79,6 @@
/**
* Returns the document ID
- *
- * @return
*/
public String getDocumentID() {
return this.documentID;
@@ -92,8 +86,6 @@
/**
* Returns the query for which the current pattern was matched
- *
- * @return
*/
public String getQueryString() {
return this.queryString;
@@ -101,10 +93,8 @@
/**
* Returns the annotation set this pattern belongs to.
- * @return
*/
public String getAnnotationSetName() {
return annotationSetName;
}
-
}
Modified: gate/trunk/src/gate/creole/annic/Indexer.java
===================================================================
--- gate/trunk/src/gate/creole/annic/Indexer.java 2012-01-10 20:04:45 UTC
(rev 14998)
+++ gate/trunk/src/gate/creole/annic/Indexer.java 2012-01-10 20:12:24 UTC
(rev 14999)
@@ -63,15 +63,11 @@
/**
* Corpus to be indexed
- *
- * @return
*/
public Corpus getCorpus();
/**
* Returns the parameters
- *
- * @return
*/
public Map getParameters();
}
Modified: gate/trunk/src/gate/creole/annic/Parser.java
===================================================================
--- gate/trunk/src/gate/creole/annic/Parser.java 2012-01-10 20:04:45 UTC
(rev 14998)
+++ gate/trunk/src/gate/creole/annic/Parser.java 2012-01-10 20:12:24 UTC
(rev 14999)
@@ -136,9 +136,6 @@
/**
* Given an array of instances of Hit, this method returns an xml
* representation of the Hit
- *
- * @param hits
- * @return
*/
public static String toXML(Hit[] hits) {
StringBuffer sb = new StringBuffer();
@@ -217,8 +214,6 @@
/**
* This method replaces all the special characters (invalid xml characters)
with their respective legal sequences.
* These includes &, <, >, \ and '.
- * @param s
- * @return
*/
public static String replaceAmpChars(String s) {
s = s.replaceAll("&", "&");
@@ -231,9 +226,6 @@
/**
* Given xml representation of HIT converts them into an array of hits
- *
- * @param xml
- * @return
* @throws IOException
*/
public static Hit[] fromXML(String xml) throws IOException, JDOMException {
@@ -301,10 +293,7 @@
/**
* wraps the element into the following format
- *
- * @param elementText
- * @param elementValue
- * @return <elementText>elementValue</elementText>\n
+ * @return <elementText>elementValue</elementText>
*/
public static String wrap(String elementText, String elementValue) {
if(elementValue == null) {
@@ -317,9 +306,7 @@
/**
* wraps the element into the following format
*
- * @param elementText
- * @param elementValue
- * @return <elementText>elementValue</elementText>\n
+ * @return <elementText>elementValue</elementText>
*/
public static String wrap(String elementText, int elementValue) {
return wrap(elementText, "" + elementValue);
@@ -327,10 +314,7 @@
/**
* wraps the element into the following format
- *
- * @param elementText
- * @param startElement
- * @return "<" + (startElement ? "" : "/") + elementText + ">\n";
+ * @return "<" + (startElement ? "" : "/") + elementText + ">\n";
*/
public static String wrap(String elementText, boolean startElement) {
return "<" + (startElement ? "" : "/") + elementText + ">\n";
Modified: gate/trunk/src/gate/creole/annic/Pattern.java
===================================================================
--- gate/trunk/src/gate/creole/annic/Pattern.java 2012-01-10 20:04:45 UTC
(rev 14998)
+++ gate/trunk/src/gate/creole/annic/Pattern.java 2012-01-10 20:12:24 UTC
(rev 14999)
@@ -72,7 +72,6 @@
*
* @param start
* @param end
- * @return
*/
public List<PatternAnnotation> getPatternAnnotations(int startOffset, int
endOffset) {
ArrayList<PatternAnnotation> annots = new ArrayList<PatternAnnotation>();
@@ -88,8 +87,6 @@
/**
* Returns all annotations underlying the pattern
- *
- * @return
*/
public PatternAnnotation[] getPatternAnnotations() {
return annotations.toArray(new PatternAnnotation[0]);
@@ -97,9 +94,6 @@
/**
* Returns the annotations with the given type
- *
- * @param type
- * @return
*/
public PatternAnnotation[] getPatternAnnotations(String type) {
List<PatternAnnotation> annots = new ArrayList<PatternAnnotation>();
@@ -114,10 +108,6 @@
/**
* Returns the annotations with the given type and the feature
- *
- * @param type
- * @param feature
- * @return
*/
public PatternAnnotation[] getPatternAnnotations(String type, String
feature) {
List<PatternAnnotation> annots = new ArrayList<PatternAnnotation>();
@@ -136,8 +126,6 @@
/**
* Returns the text of the pattern
- *
- * @return
*/
public String getPatternText() {
return patternText;
@@ -145,10 +133,6 @@
/**
* Returns the text of the pattern between the given offsets
- *
- * @param startOffset
- * @param endOffset
- * @return
*/
public String getPatternText(int startOffset, int endOffset) {
return patternText.substring(startOffset - leftContextStartOffset,
@@ -157,8 +141,6 @@
/**
* Returns the start offset of the left context
- *
- * @return
*/
public int getLeftContextStartOffset() {
return leftContextStartOffset;
@@ -166,8 +148,6 @@
/**
* Returns the end offset of the right context
- *
- * @return
*/
public int getRightContextEndOffset() {
return rightContextEndOffset;
Modified: gate/trunk/src/gate/creole/annic/PatternAnnotation.java
===================================================================
--- gate/trunk/src/gate/creole/annic/PatternAnnotation.java 2012-01-10
20:04:45 UTC (rev 14998)
+++ gate/trunk/src/gate/creole/annic/PatternAnnotation.java 2012-01-10
20:12:24 UTC (rev 14999)
@@ -114,7 +114,6 @@
/**
* Gets the Features
- * @return
*/
public Map<String, String> getFeatures() {
return features;
@@ -122,8 +121,6 @@
/**
* Gets the value of a feature
- * @param key
- * @return
*/
public String getFeature(String key) {
return (String)features.get(key);
@@ -131,7 +128,6 @@
/**
* Gets the type of the annotation
- * @return
*/
public String getType() {
return this.type;
@@ -139,7 +135,6 @@
/**
* Gets the text of the annotation
- * @return
*/
public String getText() {
return this.text;
@@ -147,7 +142,6 @@
/**
* Gets the start offset
- * @return
*/
public int getStartOffset() {
return stOffset;
@@ -155,7 +149,6 @@
/**
* Gets the end offset
- * @return
*/
public int getEndOffset() {
return enOffset;
@@ -163,7 +156,6 @@
/**
* Gets the position of this annotation in the token stream.
- * @return
*/
public int getPosition() {
return position;
Modified: gate/trunk/src/gate/creole/annic/Searchable.java
===================================================================
--- gate/trunk/src/gate/creole/annic/Searchable.java 2012-01-10 20:04:45 UTC
(rev 14998)
+++ gate/trunk/src/gate/creole/annic/Searchable.java 2012-01-10 20:12:24 UTC
(rev 14999)
@@ -31,8 +31,6 @@
/**
* Returns the Indexer
- *
- * @return
*/
public Indexer getIndexer();
@@ -47,8 +45,6 @@
/**
* Returns the Searcher
- *
- * @return
*/
public Searcher getSearcher();
Modified: gate/trunk/src/gate/creole/annic/Searcher.java
===================================================================
--- gate/trunk/src/gate/creole/annic/Searcher.java 2012-01-10 20:04:45 UTC
(rev 14998)
+++ gate/trunk/src/gate/creole/annic/Searcher.java 2012-01-10 20:12:24 UTC
(rev 14999)
@@ -7,6 +7,8 @@
*/
package gate.creole.annic;
+import gate.creole.annic.lucene.StatsCalculator;
+
import java.io.File;
import java.util.List;
import java.util.Map;
@@ -20,26 +22,17 @@
/**
* Search method that allows searching
- *
- * @param query
- * @param numberOfPatterns
- * @param patternWindow
- * @return
* @throws SearchException
*/
public boolean search(String query, Map<String, Object> parameters) throws
SearchException;
/**
* Query to search
- *
- * @return
*/
public String getQuery();
/**
* Return the next numberOfHits -1 indicates all
- *
- * @return
*/
public Hit[] next(int numberOfHits) throws SearchException;
@@ -52,7 +45,6 @@
* The results obtained has the following format.
* Key: CorpusName;AnnotationSetName;AnnotationType
* Value: respective features
- * @return
*/
public Map<String, List<String>> getAnnotationTypesMap();
@@ -62,73 +54,46 @@
* * Each entry has the following format:
* <p>corpusName;annotationSetName</p>
* where, the corpusName is the name of the corpus the annotationSetName
belongs to.
- * @param indexLocation
- * @return
* @throws SearchException
*/
public String[] getIndexedAnnotationSetNames() throws SearchException;
/**
* Returns the recently set parameters
- *
- * @return
*/
public Map<String, Object> getParameters();
/**
* This method can be used for exporting results
- *
- * @param outputFile
*/
public void exportResults(File outputFile);
/**
* return the last seen hits once again
- *
- * @return
*/
public Hit[] getHits();
- /**
- * @see StatsCalculator#freq(String, String, String, String, String)
- */
public int freq(String corpusToSearchIn,
String annotationSetToSearchIn, String annotationType,
String featureName, String value) throws SearchException;
- /**
- * @see StatsCalculator#freq(String, String, String, String, String)
- */
public int freq(String corpusToSearchIn,
String annotationSetToSearchIn, String annotationType)
throws SearchException;
- /**
- * @see StatsCalculator#freq(String, String, String, String, String)
- */
public int freq(String corpusToSearchIn,
String annotationSetToSearchIn, String annotationType,
String featureName) throws SearchException;
- /**
- * @see StatsCalculator#freq(List<Hit>, String, String, String, boolean,
boolean)
- */
public int freq(List<Hit> patternsToSearchIn,
String annotationType, String feature, String value,
boolean inMatchedSpan, boolean inContext) throws SearchException;
- /**
- * @see StatsCalculator#freq(List<Hit>, String, String, String, boolean,
boolean)
- */
public int freq(List<Hit> patternsToSearchIn,
String annotationType, boolean inMatchedSpan, boolean inContext)
throws SearchException;
- /**
- * @see StatsCalculator#freq(List<Hit>, String, String, boolean, boolean)
- */
public Map<String, Integer> freqForAllValues(
List<Hit> patternsToSearchIn, String annotationType,
String feature, boolean inMatchedSpan, boolean inContext)
throws SearchException;
-
}
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Write once. Port to many.
Get the SDK and tools to simplify cross-platform app development. Create
new or port existing apps to sell to consumers worldwide. Explore the
Intel AppUpSM program developer opportunity. appdeveloper.intel.com/join
http://p.sf.net/sfu/intel-appdev
_______________________________________________
GATE-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gate-cvs
