Revision: 15000
http://gate.svn.sourceforge.net/gate/?rev=15000&view=rev
Author: markagreenwood
Date: 2012-01-10 20:21:13 +0000 (Tue, 10 Jan 2012)
Log Message:
-----------
more javadoc fixes
Modified Paths:
--------------
gate/trunk/src/gate/creole/annic/lucene/LuceneDocument.java
gate/trunk/src/gate/creole/annic/lucene/LuceneIndexer.java
gate/trunk/src/gate/creole/annic/lucene/LuceneQueryResult.java
gate/trunk/src/gate/creole/annic/lucene/LuceneQueryResultList.java
gate/trunk/src/gate/creole/annic/lucene/LuceneReader.java
gate/trunk/src/gate/creole/annic/lucene/LuceneSearchThread.java
gate/trunk/src/gate/creole/annic/lucene/LuceneSearcher.java
gate/trunk/src/gate/creole/annic/lucene/PatternValidator.java
gate/trunk/src/gate/creole/annic/lucene/QueryParser.java
gate/trunk/src/gate/creole/annic/lucene/StatsCalculator.java
gate/trunk/src/gate/creole/annic/lucene/SubQueryParser.java
Modified: gate/trunk/src/gate/creole/annic/lucene/LuceneDocument.java
===================================================================
--- gate/trunk/src/gate/creole/annic/lucene/LuceneDocument.java 2012-01-10
20:12:24 UTC (rev 14999)
+++ gate/trunk/src/gate/creole/annic/lucene/LuceneDocument.java 2012-01-10
20:21:13 UTC (rev 15000)
@@ -47,16 +47,6 @@
* lucene can understand and can store in its indexes. This method also
stores
* the tokenStream on the disk in order to retrieve it at the time of
* searching
- *
- * @param corpusPersistenceID
- * @param gateDoc
- * @param documentID
- * @param annotSet
- * @param featuresToExclude
- * @param indexLocation
- * @param baseTokenAnnotationType
- * @param indexUnitAnnotationType
- * @return
*/
public List<Document> createDocuments(String corpusPersistenceID,
gate.Document gateDoc, String documentID,
Modified: gate/trunk/src/gate/creole/annic/lucene/LuceneIndexer.java
===================================================================
--- gate/trunk/src/gate/creole/annic/lucene/LuceneIndexer.java 2012-01-10
20:12:24 UTC (rev 14999)
+++ gate/trunk/src/gate/creole/annic/lucene/LuceneIndexer.java 2012-01-10
20:21:13 UTC (rev 15000)
@@ -123,8 +123,6 @@
/**
* Returns the indexing parameters
- *
- * @return
*/
protected Map getIndexParameters() {
return this.parameters;
@@ -260,9 +258,6 @@
/**
* Add new documents to Index
- *
- * @param corpusPersistenceID
- * @param addedDocuments
* @throws IndexException
*/
public void add(String corpusPersistenceID, List<gate.Document> added)
@@ -320,7 +315,7 @@
/**
* remove documents from the Index
*
- * @param removedDocumentPersistenceIds - when documents are not
+ * @param removedIDs - when documents are not
* peristed, Persistence IDs will not be available In that
* case provide the document Names instead of their IDs
* @throws Exception
@@ -393,11 +388,6 @@
* in the gate document. An array of Lucene document is returned as a
* call to this method. It uses various indexing parameters set
* earlier.
- *
- * @param corpusPersistenceID
- * @param gateDoc
- * @param location
- * @return
* @throws IndexException
*/
private List<gate.creole.annic.apache.lucene.document.Document>
getLuceneDocuments(
@@ -549,8 +539,6 @@
/**
* This method returns a set of annotation set names that are indexed.
- *
- * @return
*/
public Set<String> getNamesOfSerializedFiles(String documentID)
throws IndexException {
Modified: gate/trunk/src/gate/creole/annic/lucene/LuceneQueryResult.java
===================================================================
--- gate/trunk/src/gate/creole/annic/lucene/LuceneQueryResult.java
2012-01-10 20:12:24 UTC (rev 14999)
+++ gate/trunk/src/gate/creole/annic/lucene/LuceneQueryResult.java
2012-01-10 20:21:13 UTC (rev 15000)
@@ -89,8 +89,6 @@
/**
* Returns an arraylist which for each pattern contains a number of
* annotation in it.
- *
- * @return
*/
public List<Integer> patternLength() {
return patternLength;
@@ -98,7 +96,6 @@
/**
* Gets the GateAnnotations for each pattern.
- * @return
*/
public List<List<PatternAnnotation>> getGateAnnotations() {
return this.gateAnnotations;
@@ -106,7 +103,6 @@
/**
* Returns the main query.
- * @return
*/
public String getQuery() {
return this.query;
@@ -114,7 +110,6 @@
/**
* Gets the annotation set Name for this result
- * @return
*/
public String getAnnotationSetName() {
return annotationSetName;
Modified: gate/trunk/src/gate/creole/annic/lucene/LuceneQueryResultList.java
===================================================================
--- gate/trunk/src/gate/creole/annic/lucene/LuceneQueryResultList.java
2012-01-10 20:12:24 UTC (rev 14999)
+++ gate/trunk/src/gate/creole/annic/lucene/LuceneQueryResultList.java
2012-01-10 20:21:13 UTC (rev 15000)
@@ -42,8 +42,7 @@
}
/**
- * Total number of patterns
- * @return
+ * @return Total number of patterns
*/
public int getTotalNumberOfPatterns() {
int total = 0;
Modified: gate/trunk/src/gate/creole/annic/lucene/LuceneReader.java
===================================================================
--- gate/trunk/src/gate/creole/annic/lucene/LuceneReader.java 2012-01-10
20:12:24 UTC (rev 14999)
+++ gate/trunk/src/gate/creole/annic/lucene/LuceneReader.java 2012-01-10
20:21:13 UTC (rev 15000)
@@ -47,8 +47,6 @@
/**
* Gets the document object
- *
- * @return
*/
public gate.Document getDocument() {
return this.gateDoc;
@@ -56,8 +54,6 @@
/**
* Gets the token stream associated with this reader
- *
- * @return
*/
public List<Token> getTokenStream() {
return this.tokenStream;
Modified: gate/trunk/src/gate/creole/annic/lucene/LuceneSearchThread.java
===================================================================
--- gate/trunk/src/gate/creole/annic/lucene/LuceneSearchThread.java
2012-01-10 20:12:24 UTC (rev 14999)
+++ gate/trunk/src/gate/creole/annic/lucene/LuceneSearchThread.java
2012-01-10 20:21:13 UTC (rev 15000)
@@ -137,7 +137,6 @@
* This method collects the necessary information from lucene and uses
* it when the next method is called
*
- * @param limit limit indicates the number of patterns to retrieve
* @param query query supplied by the user
* @param patternWindow number of tokens to refer on left and right
* context
@@ -1124,10 +1123,6 @@
/**
* Checks if two first term positions are identical.
- * @param ftp
- * @param ftp1
- * @param qType
- * @return
*/
private boolean areTheyEqual(List ftp, List ftp1, int qType) {
if(qType == 1) {
@@ -1154,8 +1149,6 @@
/**
* Gets the query.
- *
- * @return
*/
public String getQuery() {
return query;
Modified: gate/trunk/src/gate/creole/annic/lucene/LuceneSearcher.java
===================================================================
--- gate/trunk/src/gate/creole/annic/lucene/LuceneSearcher.java 2012-01-10
20:12:24 UTC (rev 14999)
+++ gate/trunk/src/gate/creole/annic/lucene/LuceneSearcher.java 2012-01-10
20:21:13 UTC (rev 15000)
@@ -122,8 +122,6 @@
/**
* Return the next numberOfHits -1 indicates all
- *
- * @return
*/
public Hit[] next(int numberOfHits) throws SearchException {
@@ -327,8 +325,6 @@
/**
* Gets the number of base token annotations to show in the context.
- *
- * @return
*/
public Integer getContextWindow() {
return new Integer(this.contextWindow);
@@ -366,8 +362,6 @@
* </p>
* where, the corpusName is the name of the corpus the annotationSetName
* belongs to.
- *
- * @return
*/
public String[] getIndexedAnnotationSetNames() throws SearchException {
String indexLocation;
@@ -496,9 +490,6 @@
/**
* Gets the query tokens for the given query.
- *
- * @param query
- * @return
*/
public synchronized List<String> getQueryTokens(String query) {
return queryTokens.get(query);
@@ -506,9 +497,6 @@
/**
* Adds the query tokens for the given query.
- *
- * @param query
- * @param queryTokens
*/
public synchronized void addQueryTokens(String query, List<String>
queryTokens) {
this.queryTokens.put(query, queryTokens);
Modified: gate/trunk/src/gate/creole/annic/lucene/PatternValidator.java
===================================================================
--- gate/trunk/src/gate/creole/annic/lucene/PatternValidator.java
2012-01-10 20:12:24 UTC (rev 14999)
+++ gate/trunk/src/gate/creole/annic/lucene/PatternValidator.java
2012-01-10 20:21:13 UTC (rev 15000)
@@ -42,8 +42,6 @@
/**
* Gets the length of the pattern.
- *
- * @return
*/
public int getPatternLength() {
return patLen;
@@ -54,8 +52,6 @@
* annotations in which it checks if the annotations exist that are
* validating for the given query
*
- * @param query String
- * @param annotations ArrayList
* @throws SearchException
* @return int positive number indicates the offset of the last
* annotation of the pattern. -1 indicates invalid pattern.
Modified: gate/trunk/src/gate/creole/annic/lucene/QueryParser.java
===================================================================
--- gate/trunk/src/gate/creole/annic/lucene/QueryParser.java 2012-01-10
20:12:24 UTC (rev 14999)
+++ gate/trunk/src/gate/creole/annic/lucene/QueryParser.java 2012-01-10
20:21:13 UTC (rev 15000)
@@ -56,9 +56,6 @@
/**
* Returns true if the submitted query is valid.
- *
- * @param query
- * @return
*/
public static boolean isValidQuery(String query) {
QueryParser qp = new QueryParser();
@@ -74,12 +71,6 @@
/**
* Given a query, this method parses it to convert it into one or more
* lucene queries.
- *
- * @param field
- * @param query
- * @param baseTokenAnnotationType
- * @param corpusID
- * @return
* @throws gate.creole.ir.SearchException
*/
public Query[] parse(String field, String query,
@@ -151,9 +142,6 @@
* When user submits an ANNIC query, one or more instances of lucene
* queries are created and returned. This method returns the string
* representation of the query at the given index.
- *
- * @param i
- * @return
*/
public String getQueryString(int i) {
return (String)queries.get(i);
@@ -273,9 +261,6 @@
* base token term it has to satisify the following terms: 1. If its
* text is baseTokenAnnotationType and the type is "*" or 2. If its
* type = "baseTokenAnnotationType.feature"
- *
- * @param t
- * @return
*/
private boolean isBaseTokenTerm(Term t) {
// the term refers to the base token
@@ -298,9 +283,6 @@
/**
* Given a query this method returns tokens. Here token is an object
* of string.
- *
- * @param query
- * @return
* @throws gate.creole.ir.SearchException
*/
public List<String> findTokens(String query)
Modified: gate/trunk/src/gate/creole/annic/lucene/StatsCalculator.java
===================================================================
--- gate/trunk/src/gate/creole/annic/lucene/StatsCalculator.java
2012-01-10 20:12:24 UTC (rev 14999)
+++ gate/trunk/src/gate/creole/annic/lucene/StatsCalculator.java
2012-01-10 20:21:13 UTC (rev 15000)
@@ -17,14 +17,6 @@
* sure that you close the searcher on your own. Failing to do so may
* result into many files being opened at the same time and that can
* cause the problem with your OS.
- *
- * @param searcher
- * @param corpusToSearchIn
- * @param annotationSetToSearchIn
- * @param annotationType
- * @param featureName
- * @param value
- * @return
* @throws SearchException
*/
public static int freq(IndexSearcher searcher, String corpusToSearchIn,
@@ -143,15 +135,11 @@
/**
* Allows retrieving frequencies for the given parameters.
- * @param patternsToSearchIn
- * @param annotationType
- * @param feature
* @param value - set to null if only wants to retrieve frequencies for
AT.feature
* @param inMatchedSpan - true if only interested in frequencies from the
matched spans.
* @param inContext - true if only interested in frequencies from the
contexts. Please note that both isMatchedSpan
* and inContext can be set to true if interested in frequencies from the
entire patterns, but cannot be set false
* at the same time.
- * @return
* @throws SearchException
*/
public static int freq(List<Hit> patternsToSearchIn,
@@ -200,7 +188,7 @@
/**
- * @see #freq(List<Hit>, String, String, String, boolean, boolean)
+ * @see #freq(List, String, String, String, boolean, boolean)
*/
public static int freq(List<Hit> patternsToSearchIn,
String annotationType, boolean inMatchedSpan, boolean inContext)
throws SearchException {
Modified: gate/trunk/src/gate/creole/annic/lucene/SubQueryParser.java
===================================================================
--- gate/trunk/src/gate/creole/annic/lucene/SubQueryParser.java 2012-01-10
20:12:24 UTC (rev 14999)
+++ gate/trunk/src/gate/creole/annic/lucene/SubQueryParser.java 2012-01-10
20:21:13 UTC (rev 15000)
@@ -159,9 +159,6 @@
* and the arrayList consists of
* 1. {A}{C}
* 2. {B}{C}
- *
- * @param q1
- * @return
* @throws SearchException
*/
public static ArrayList<String> parseQuery(String q1) throws SearchException
{
@@ -337,8 +334,6 @@
/**
* This method checks if query has either | or ( in it.
- * @param query
- * @return
*/
public static boolean scanQueryForOrOrBracket(String query) {
int index = 0;
@@ -448,8 +443,6 @@
* and ({B}{C})
* so basically findOrTokens find out all the tokens around
* | operator
- * @param query
- * @return
*/
public static ArrayList<String> findOrTokens(String query) {
int balance = 0;
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
