You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2010/05/18 14:53:56 UTC
svn commit: r945633 - in /uima/sandbox/trunk:
Lucas/src/main/java/org/apache/uima/lucas/
Lucas/src/main/java/org/apache/uima/lucas/indexer/analysis/
RegularExpressionAnnotator/src/main/java/org/apache/uima/annotator/regex/impl/
SimpleServer/src/main/ja...
Author: schor
Date: Tue May 18 12:53:55 2010
New Revision: 945633
URL: http://svn.apache.org/viewvc?rev=945633&view=rev
Log:
[UIMA-1756] clean up javadoc warnings, remove empty element in aggregate-addons
Modified:
uima/sandbox/trunk/Lucas/src/main/java/org/apache/uima/lucas/SearchQuery.java
uima/sandbox/trunk/Lucas/src/main/java/org/apache/uima/lucas/SearchQueryProvider.java
uima/sandbox/trunk/Lucas/src/main/java/org/apache/uima/lucas/indexer/analysis/AnnotationTokenStream.java
uima/sandbox/trunk/RegularExpressionAnnotator/src/main/java/org/apache/uima/annotator/regex/impl/FilterFeature_impl.java
uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/Service.java
uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/config/OrFilter.java
uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/config/impl/AndFilterImpl.java
uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/config/impl/OrFilterImpl.java
uima/sandbox/trunk/aggregate-addons/pom.xml
Modified: uima/sandbox/trunk/Lucas/src/main/java/org/apache/uima/lucas/SearchQuery.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/Lucas/src/main/java/org/apache/uima/lucas/SearchQuery.java?rev=945633&r1=945632&r2=945633&view=diff
==============================================================================
--- uima/sandbox/trunk/Lucas/src/main/java/org/apache/uima/lucas/SearchQuery.java (original)
+++ uima/sandbox/trunk/Lucas/src/main/java/org/apache/uima/lucas/SearchQuery.java Tue May 18 12:53:55 2010
@@ -32,14 +32,14 @@ public interface SearchQuery {
/**
* Id of the search query.
*
- * @return
+ * @return Id of the search query.
*/
long id();
/**
* The Lucene query.
*
- * @return
+ * @return The Lucene query.
*/
Query query();
}
Modified: uima/sandbox/trunk/Lucas/src/main/java/org/apache/uima/lucas/SearchQueryProvider.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/Lucas/src/main/java/org/apache/uima/lucas/SearchQueryProvider.java?rev=945633&r1=945632&r2=945633&view=diff
==============================================================================
--- uima/sandbox/trunk/Lucas/src/main/java/org/apache/uima/lucas/SearchQueryProvider.java (original)
+++ uima/sandbox/trunk/Lucas/src/main/java/org/apache/uima/lucas/SearchQueryProvider.java Tue May 18 12:53:55 2010
@@ -40,7 +40,7 @@ public interface SearchQueryProvider {
* Note: The implementation must be thread safe.
*
* @param cas
- * @return
+ * @return all {@link SearchQuery}s for the given <code>CAS</code>.
* @throws AnalysisEngineProcessException
*/
Collection<SearchQuery> getSearchQueries(CAS cas) throws AnalysisEngineProcessException;
Modified: uima/sandbox/trunk/Lucas/src/main/java/org/apache/uima/lucas/indexer/analysis/AnnotationTokenStream.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/Lucas/src/main/java/org/apache/uima/lucas/indexer/analysis/AnnotationTokenStream.java?rev=945633&r1=945632&r2=945633&view=diff
==============================================================================
--- uima/sandbox/trunk/Lucas/src/main/java/org/apache/uima/lucas/indexer/analysis/AnnotationTokenStream.java (original)
+++ uima/sandbox/trunk/Lucas/src/main/java/org/apache/uima/lucas/indexer/analysis/AnnotationTokenStream.java Tue May 18 12:53:55 2010
@@ -99,12 +99,13 @@ public class AnnotationTokenStream exten
*
* @param jCas
* the jCas
+ * @param sofaName the name of the subject of analysis (sofa)
* @param typeName
* the type of the annotation
* @throws CASException
*/
- public AnnotationTokenStream(JCas cas, String sofaName, String typeName) throws InvalidTokenSourceException {
- this(cas, sofaName, typeName, null, Collections.<String>emptyList(), null,
+ public AnnotationTokenStream(JCas jCas, String sofaName, String typeName) throws InvalidTokenSourceException {
+ this(jCas, sofaName, typeName, null, Collections.<String>emptyList(), null,
Collections.<String, Format>emptyMap());
}
@@ -115,18 +116,19 @@ public class AnnotationTokenStream exten
*
* @param jCas
* the JCas object
- * @param type
+ * @param sofaName the name of the subject of analysis (sofa)
+ * @param typeName
* the type of the annotation
* @param featureName
* the name of the feature from which the token text is build
* @param featureFormat
* optional format object to convert feature values to strings
- * @throws CASException
+ * @throws InvalidTokenSourceException
*/
- public AnnotationTokenStream(JCas cas, String sofaName, String typeName, String featureName,
+ public AnnotationTokenStream(JCas jCas, String sofaName, String typeName, String featureName,
Format featureFormat) throws InvalidTokenSourceException {
- this(cas, sofaName, typeName, null, Lists.newArrayList(featureName), null,
+ this(jCas, sofaName, typeName, null, Lists.newArrayList(featureName), null,
featureFormat != null ? ImmutableBiMap.of(featureName, featureFormat): Collections.<String, Format>emptyMap());
}
@@ -138,7 +140,8 @@ public class AnnotationTokenStream exten
*
* @param jCas
* the JCas object
- * @param type
+ * @param sofaName the name of the Subject Of Analysis (sofa)
+ * @param typeName
* the type of the annotation
* @param featureNames
* the name of the feature from which the token text is build
@@ -148,12 +151,12 @@ public class AnnotationTokenStream exten
* @param featureFormats
* optional map of format objects to convert feature values to strings - the key must be
* the feature name
- * @throws CASException
+ * @throws InvalidTokenSourceException
*/
- public AnnotationTokenStream(JCas cas, String sofaName, String typeName,
+ public AnnotationTokenStream(JCas jCas, String sofaName, String typeName,
List<String> featureNames, String delimiter, Map<String, Format> featureFormats)
throws InvalidTokenSourceException {
- this(cas, sofaName, typeName, null, featureNames, delimiter, featureFormats);
+ this(jCas, sofaName, typeName, null, featureNames, delimiter, featureFormats);
}
/**
@@ -163,18 +166,19 @@ public class AnnotationTokenStream exten
*
* @param jCas
* the JCas object
- * @param type
+ * @param sofaName the name of the Subject Of Analysis (sofa)
+ * @param typeName
* the type of the annotation
* @param featureNames
* the name of the feature from which the token text is build
* @param featureFormats
* optional map of format objects to convert feature values to strings - the key must be
* the feature name
- * @throws CASException
+ * @throws InvalidTokenSourceException
*/
- public AnnotationTokenStream(JCas cas, String sofaName, String typeName,
+ public AnnotationTokenStream(JCas jCas, String sofaName, String typeName,
List<String> featureNames, Map<String, Format> featureFormats) throws InvalidTokenSourceException {
- this(cas, sofaName, typeName, null, featureNames, null, featureFormats);
+ this(jCas, sofaName, typeName, null, featureNames, null, featureFormats);
}
/**
@@ -189,7 +193,8 @@ public class AnnotationTokenStream exten
*
* @param jCas
* the JCas object
- * @param type
+ * @param sofaName the name of the Subject of Analysis (sofa)
+ * @param typeName
* the type of the annotation
* @param featurePath
* the path to the feature structures which features should be used for tokens Path
@@ -197,17 +202,14 @@ public class AnnotationTokenStream exten
* "affiliation.address.country"
* @param featureNames
* the name of the feature from which the token text is build
- * @param delimiter
- * a delimiter for concatenating the different feature values of an annotation object. If
- * null a white space will be used.
* @param featureFormats
* optional map of format objects to convert feature values to strings - the key must be
* the feature name
- * @throws CASException
+ * @throws InvalidTokenSourceException
*/
- public AnnotationTokenStream(JCas cas, String sofaName, String typeName, String featurePath,
+ public AnnotationTokenStream(JCas jCas, String sofaName, String typeName, String featurePath,
List<String> featureNames, Map<String, Format> featureFormats) throws InvalidTokenSourceException {
- this(cas, sofaName, typeName, featurePath, featureNames, null, featureFormats);
+ this(jCas, sofaName, typeName, featurePath, featureNames, null, featureFormats);
}
/**
@@ -223,7 +225,8 @@ public class AnnotationTokenStream exten
*
* @param jCas
* the JCas object
- * @param type
+ * @param sofaName the name of the Subject of Analysis (sofa)
+ * @param typeName
* the type of the annotation
* @param featurePath
* the path to the feature structures which features should be used for tokens Path
@@ -237,9 +240,9 @@ public class AnnotationTokenStream exten
* @param featureFormats
* optional map of format objects to convert feature values to strings - the key must be
* the feature name
- * @throws CASException
+ * @throws InvalidTokenSourceException
*/
- public AnnotationTokenStream(JCas cas, String sofaName, String typeName, String featurePath,
+ public AnnotationTokenStream(JCas jCas, String sofaName, String typeName, String featurePath,
List<String> featureNames, String delimiter, Map<String, Format> featureFormats)
throws InvalidTokenSourceException {
super();
@@ -252,7 +255,7 @@ public class AnnotationTokenStream exten
else
this.featureFormats = featureFormats;
- getSofaCas(cas, sofaName);
+ getSofaCas(jCas, sofaName);
getTypeForName(typeName);
validate(annotationType, featureNames, featurePath);
Modified: uima/sandbox/trunk/RegularExpressionAnnotator/src/main/java/org/apache/uima/annotator/regex/impl/FilterFeature_impl.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/RegularExpressionAnnotator/src/main/java/org/apache/uima/annotator/regex/impl/FilterFeature_impl.java?rev=945633&r1=945632&r2=945633&view=diff
==============================================================================
--- uima/sandbox/trunk/RegularExpressionAnnotator/src/main/java/org/apache/uima/annotator/regex/impl/FilterFeature_impl.java (original)
+++ uima/sandbox/trunk/RegularExpressionAnnotator/src/main/java/org/apache/uima/annotator/regex/impl/FilterFeature_impl.java Tue May 18 12:53:55 2010
@@ -40,7 +40,7 @@ public class FilterFeature_impl implemen
private Pattern pattern;
/**
- * @param featurePath
+ * @param featurePathString
* @param patternStr
*/
public FilterFeature_impl(String featurePathString, String patternStr) {
Modified: uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/Service.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/Service.java?rev=945633&r1=945632&r2=945633&view=diff
==============================================================================
--- uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/Service.java (original)
+++ uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/Service.java Tue May 18 12:53:55 2010
@@ -126,7 +126,7 @@ public class Service {
* The PEAR file.
* @param pearInstallationDir
* The installation directory for the PEAR.
- * @param resultSpecXMLFile
+ * @param serviceSpecFile
* Service specification file.
* @throws XmlException
* If service spec is not valid XML.
Modified: uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/config/OrFilter.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/config/OrFilter.java?rev=945633&r1=945632&r2=945633&view=diff
==============================================================================
--- uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/config/OrFilter.java (original)
+++ uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/config/OrFilter.java Tue May 18 12:53:55 2010
@@ -27,7 +27,7 @@ import java.util.List;
public interface OrFilter extends Filter {
/**
- * @param readFilter
+ * @param filter
*/
void addFilter(Filter filter);
Modified: uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/config/impl/AndFilterImpl.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/config/impl/AndFilterImpl.java?rev=945633&r1=945632&r2=945633&view=diff
==============================================================================
--- uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/config/impl/AndFilterImpl.java (original)
+++ uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/config/impl/AndFilterImpl.java Tue May 18 12:53:55 2010
@@ -35,9 +35,6 @@ public class AndFilterImpl extends Filte
private final List<Filter> filters = new ArrayList<Filter>();
- /**
- * @param type
- */
public AndFilterImpl() {
super(Filter.FilterType.AND);
}
Modified: uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/config/impl/OrFilterImpl.java
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/config/impl/OrFilterImpl.java?rev=945633&r1=945632&r2=945633&view=diff
==============================================================================
--- uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/config/impl/OrFilterImpl.java (original)
+++ uima/sandbox/trunk/SimpleServer/src/main/java/org/apache/uima/simpleserver/config/impl/OrFilterImpl.java Tue May 18 12:53:55 2010
@@ -35,9 +35,6 @@ public class OrFilterImpl extends Filter
private final List<Filter> filters = new ArrayList<Filter>();
- /**
- * @param type
- */
public OrFilterImpl() {
super(Filter.FilterType.OR);
}
Modified: uima/sandbox/trunk/aggregate-addons/pom.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/aggregate-addons/pom.xml?rev=945633&r1=945632&r2=945633&view=diff
==============================================================================
--- uima/sandbox/trunk/aggregate-addons/pom.xml (original)
+++ uima/sandbox/trunk/aggregate-addons/pom.xml Tue May 18 12:53:55 2010
@@ -78,4 +78,8 @@
<module>../TikaAnnotator</module>
<module>../WhitespaceTokenizer</module>
</modules>
+
+ <profiles>
+
+ </profiles>
</project>
\ No newline at end of file