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 2013/09/09 16:16:56 UTC
svn commit: r1521121 -
/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/
Author: schor
Date: Mon Sep 9 14:16:55 2013
New Revision: 1521121
URL: http://svn.apache.org/r1521121
Log:
[UIMA-3256] fixup Javadocs
Modified:
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AggregateAnalysisEngine_impl.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AnalysisEngineDescription_impl.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AnalysisEngineImplBase.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/PrimitiveAnalysisEngine_impl.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/ResultSpecification_impl.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsFeats.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsLangs.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsType.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/TypeOrFeature_impl.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/UimacppAnalysisEngineImpl.java
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AggregateAnalysisEngine_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AggregateAnalysisEngine_impl.java?rev=1521121&r1=1521120&r2=1521121&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AggregateAnalysisEngine_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AggregateAnalysisEngine_impl.java Mon Sep 9 14:16:55 2013
@@ -227,7 +227,7 @@ public class AggregateAnalysisEngine_imp
/**
* Gets an array containing all capabilities of all components of this aggregate
*
- * @return
+ * @return all capabilities of all components of this aggregate
*/
private Capability[] getAllComponentCapabilities() {
ArrayList<Capability> capabilityList = new ArrayList<Capability>();
@@ -279,7 +279,7 @@ public class AggregateAnalysisEngine_imp
}
/**
- * @see org.apache.uima.resource.AnalysisEngine#reconfigure()
+ * @see org.apache.uima.analysis_engine.AnalysisEngine#reconfigure()
*/
public void reconfigure() throws ResourceConfigurationException {
// do base resource reconfiguration
@@ -384,9 +384,9 @@ public class AggregateAnalysisEngine_imp
* A utility method that creates and configures the ASB component. The ASB will create and
* initialize the delegate AnalysisEngines. This method also retrieves delegate AnalysisEngine
* metadata from the ASB and provides access to that method via the
- * {@link _getDelegateAnalysisEngineMetaData()} method.
+ * {@link #_getComponentMetaData()} method.
*
- * @param aDescription
+ * @param aAnalysisEngineDescription
* the AnalysisEngine description for this AnalysisEngine
* @param aAdditionalParams
* parameters that will be passed to the ASB's initialize method.
@@ -498,9 +498,6 @@ public class AggregateAnalysisEngine_imp
* multipleDeploymentAlloiwed == true if it contains a component with multipleDeploymentAllowed ==
* false.
*
- * @param aDesc
- * the aggregate analysis engine description to validate
- *
* @throws ResourceInitializationException
* if there is an invalid parameter override declaration
*/
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AnalysisEngineDescription_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AnalysisEngineDescription_impl.java?rev=1521121&r1=1521120&r2=1521121&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AnalysisEngineDescription_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AnalysisEngineDescription_impl.java Mon Sep 9 14:16:55 2013
@@ -59,6 +59,7 @@ import org.apache.uima.resource.metadata
import org.apache.uima.resource.metadata.MetaDataObject;
import org.apache.uima.resource.metadata.OperationalProperties;
import org.apache.uima.resource.metadata.impl.Import_impl;
+import org.apache.uima.resource.metadata.impl.MetaDataObject_impl;
import org.apache.uima.resource.metadata.impl.PropertyXmlInfo;
import org.apache.uima.resource.metadata.impl.XmlizationInfo;
import org.apache.uima.util.InvalidXMLException;
@@ -73,8 +74,8 @@ import org.xml.sax.SAXException;
/**
* Reference implementation of {@link AnalysisEngineDescription}. Note that this class contains two
* attributes of class Map, which are not supported by the default XML input/output routines.
- * Therefore we override the {@link #writeAttributeAsElement(String,Class,Object,Writer)} and
- * {@link #readAttributeFromXMLElement(String,Class,Element,XMLParser)} methods.
+ * Therefore we override the {@link MetaDataObject_impl#writePropertyAsElement(PropertyXmlInfo, String, ContentHandler)} and
+ * {@link MetaDataObject_impl#readPropertyValueFromXMLElement(PropertyXmlInfo, Element, XMLParser, ParsingOptions)} methods.
*
*
*/
@@ -326,7 +327,7 @@ public class AnalysisEngineDescription_i
}
/**
- * Overrides{@link ResourceCreationSpecifier_impl#checkForInvalidParameterOverrides(ConfigurationParameter[], String)
+ * Overrides{@link ResourceCreationSpecifier_impl#checkForInvalidParameterOverrides(ConfigurationParameter[], String, ResourceManager)}
* to validate parameter overrides in an aggregate AE. Also logs a warning for aggregate
* parameters with no declared overrides.
*
@@ -442,8 +443,6 @@ public class AnalysisEngineDescription_i
/**
* Validate SofA mappings and inputs/outputs for an aggregate AE.
- *
- * @param aDesc
*/
protected void validateSofaMappings() throws ResourceInitializationException {
if (this.isPrimitive())
@@ -635,7 +634,7 @@ public class AnalysisEngineDescription_i
* implementation won't return it because it has no set method. We've also overridden the XML
* import/export methods, though, so that set methods are not required.
*
- * @see org.apache.uima.resource.MetaDataObject#listAttributes()
+ * @see MetaDataObject#listAttributes()
*/
public List<NameClassPair> listAttributes() {
List<NameClassPair> result = super.listAttributes();
@@ -851,8 +850,9 @@ public class AnalysisEngineDescription_i
* attribute has a value of type <code>Map</code>, which is not handled by the default XML
* export logic.
*
- * @see org.apache.uima.MetaDataObject_impl#writePropertyAsElement(PropertyXmlInfo,String,ContentHandler)
+ * @see org.apache.uima.resource.metadata.impl.MetaDataObject_impl#writePropertyAsElement(PropertyXmlInfo,String,ContentHandler)
*/
+ @Override
protected void writePropertyAsElement(PropertyXmlInfo aPropInfo, String aNamespace,
ContentHandler aContentHandler) throws SAXException {
if (PROP_DELEGATE_ANALYSIS_ENGINE_SPECIFIERS_WITH_IMPORTS.equals(aPropInfo.propertyName)) {
@@ -880,9 +880,9 @@ public class AnalysisEngineDescription_i
* attribute has a value of type <code>Map</code>, which is not handled by the default XML
* import logic.
*
- * @see org.apache.uima.resource.impl.MetaDataObject_impl#readPropertyValueFromXMLElement(org.apache.uima.resource.impl.PropertyXmlInfo,
- * org.w3c.dom.Element, org.apache.uima.util.XMLParser)
+ * @see MetaDataObject_impl#readPropertyValueFromXMLElement(PropertyXmlInfo, Element, XMLParser, ParsingOptions)
*/
+ @Override
protected void readPropertyValueFromXMLElement(PropertyXmlInfo aPropXmlInfo, Element aElement,
XMLParser aParser, XMLParser.ParsingOptions aOptions) throws InvalidXMLException {
String propName = aPropXmlInfo.propertyName;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AnalysisEngineImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AnalysisEngineImplBase.java?rev=1521121&r1=1521120&r2=1521121&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AnalysisEngineImplBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/AnalysisEngineImplBase.java Mon Sep 9 14:16:55 2013
@@ -217,7 +217,7 @@ public abstract class AnalysisEngineImpl
}
/**
- * @see org.apache.uima.cas_processor.CasProcessor#getProcessingResourceMetaData()
+ * @see org.apache.uima.collection.base_cpm.CasProcessor#getProcessingResourceMetaData()
*/
public ProcessingResourceMetaData getProcessingResourceMetaData() {
return (ProcessingResourceMetaData) getMetaData();
@@ -274,14 +274,14 @@ public abstract class AnalysisEngineImpl
}
/**
- * @see org.apache.uima.analysis_engine.AnalysisEngine#process(org.apache.uima.jcas.impl.JCas)
+ * @see org.apache.uima.analysis_engine.AnalysisEngine#process(org.apache.uima.jcas.JCas)
*/
public ProcessTrace process(JCas aJCas) throws AnalysisEngineProcessException {
return process(aJCas.getCas());
}
/**
- * @see org.apache.uima.analysis_engine.AnalysisEngine#process(org.apache.uima.jcas.impl.JCas,
+ * @see org.apache.uima.analysis_engine.AnalysisEngine#process(org.apache.uima.jcas.JCas,
* org.apache.uima.analysis_engine.ResultSpecification)
*/
public ProcessTrace process(JCas aJCas, ResultSpecification aResultSpec)
@@ -290,7 +290,7 @@ public abstract class AnalysisEngineImpl
}
/**
- * @see org.apache.uima.analysis_engine.AnalysisEngine#process(org.apache.uima.jcas.impl.JCas,
+ * @see org.apache.uima.analysis_engine.AnalysisEngine#process(org.apache.uima.jcas.JCas,
* org.apache.uima.analysis_engine.ResultSpecification, org.apache.uima.util.ProcessTrace)
*/
public void process(JCas aJCas, ResultSpecification aResultSpec, ProcessTrace aTrace)
@@ -311,7 +311,7 @@ public abstract class AnalysisEngineImpl
/*
* (non-Javadoc)
*
- * @see org.apache.uima.cas_processor.CasObjectProcessor#process(org.apache.uima.cas.CAS)
+ * @see org.apache.uima.collection.base_cpm.CasObjectProcessor#process(org.apache.uima.cas.CAS)
*/
public void processCas(CAS aCAS) throws ResourceProcessException {
try {
@@ -322,7 +322,7 @@ public abstract class AnalysisEngineImpl
}
/**
- * @see org.apache.uima.cas_processor.CasObjectProcessor#processCas(org.apache.uima.cas.CAS[])
+ * @see org.apache.uima.collection.base_cpm.CasObjectProcessor#processCas(org.apache.uima.cas.CAS[])
*/
public void processCas(CAS[] aCASes) throws ResourceProcessException {
for (int i = 0; i < aCASes.length; i++) {
@@ -380,7 +380,7 @@ public abstract class AnalysisEngineImpl
/*
* (non-Javadoc)
*
- * @see org.apache.uima.cas_processor.CasProcessor#isStateless()
+ * @see org.apache.uima.collection.base_cpm.CasProcessor#isStateless()
*/
public boolean isStateless() {
return false;
@@ -389,7 +389,7 @@ public abstract class AnalysisEngineImpl
/*
* (non-Javadoc)
*
- * @see org.apache.uima.cas_processor.CasProcessor#isReadOnly()
+ * @see org.apache.uima.collection.base_cpm.CasProcessor#isReadOnly()
*/
public boolean isReadOnly() {
OperationalProperties opProps = getAnalysisEngineMetaData().getOperationalProperties();
@@ -484,7 +484,7 @@ public abstract class AnalysisEngineImpl
* Kludge - make this public (but not part of AnalysisEngine interface) so that TAFAnnotator can
* access it.
*
- * @see org.apache.uima.resource.ConfigurableResource_ImplBase#getCurrentConfigParameterSettings()
+ * @see org.apache.uima.resource.ConfigurationManager#getCurrentConfigParameterSettings(String)
*/
protected ConfigurationParameterSettings getCurrentConfigParameterSettings() {
return getUimaContextAdmin().getConfigurationManager().getCurrentConfigParameterSettings(
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/PrimitiveAnalysisEngine_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/PrimitiveAnalysisEngine_impl.java?rev=1521121&r1=1521120&r2=1521121&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/PrimitiveAnalysisEngine_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/PrimitiveAnalysisEngine_impl.java Mon Sep 9 14:16:55 2013
@@ -328,10 +328,6 @@ public class PrimitiveAnalysisEngine_imp
*
* @param aCAS
* CAS to be processed by annotator
- * @param aResultSpec
- * result specification to be passed to annotator
- * @param aProcessTrace
- * keeps track of time spent in each component
*/
protected void callAnalysisComponentProcess(CAS aCAS) throws AnalysisEngineProcessException {
// logging and instrumentation
@@ -532,7 +528,7 @@ public class PrimitiveAnalysisEngine_imp
}
/**
- * @see org.apache.uima.resource.AnalysisEngine#reconfigure()
+ * @see org.apache.uima.analysis_engine.AnalysisEngine#reconfigure()
*/
public void reconfigure() throws ResourceConfigurationException {
// do base resource reconfiguration
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/ResultSpecification_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/ResultSpecification_impl.java?rev=1521121&r1=1521120&r2=1521121&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/ResultSpecification_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/ResultSpecification_impl.java Mon Sep 9 14:16:55 2013
@@ -454,7 +454,7 @@ public final class ResultSpecification_i
*
* @param rsLangs
* @param language
- * @return
+ * @return true if the rsLangs subsumes the language
*/
private static boolean hasLanguage(RsLangs rsLangs, String language) {
language = Language.normalize(language);
@@ -466,7 +466,7 @@ public final class ResultSpecification_i
/**
- * @see org.apache.uima.resource.impl.MetaDataObject_impl#getXmlizationInfo()
+ * @see org.apache.uima.resource.metadata.impl.MetaDataObject_impl#getXmlizationInfo()
*/
@Override
protected XmlizationInfo getXmlizationInfo() {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsFeats.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsFeats.java?rev=1521121&r1=1521120&r2=1521121&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsFeats.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsFeats.java Mon Sep 9 14:16:55 2013
@@ -97,7 +97,7 @@ public class RsFeats implements Iterable
/**
* linear search in list for short feat name
* @param shortFeatName - canonicalized short feature name
- * @return
+ * @return the RsFeat or null
*/
RsFeat get(String shortFeatName) {
for (RsFeat r : features) {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsLangs.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsLangs.java?rev=1521121&r1=1521120&r2=1521121&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsLangs.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsLangs.java Mon Sep 9 14:16:55 2013
@@ -110,7 +110,7 @@ public class RsLangs {
*
* @param rsl may be null (means x-unspec, subsumes all)
* @param lang
- * @return
+ * @return true if rsl subsumes lang
*/
static boolean subsumes(RsLangs rsl, String lang) {
return subsumesCanonical(rsl, RsLang.getCanonicalLanguageString(lang));
@@ -143,7 +143,7 @@ public class RsLangs {
* @param rsl assumed to be not null, not x-unspec
* @param lang assumed to be not null, not x-unspec
* @param baseLang
- * @return
+ * @return true if any of the rsl languages is equal to the lang or the base lang
*/
private static boolean subsumesCanonical(RsLangs rsl, String lang, String baseLang) {
for (String rsLang : rsl.languages) {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsType.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsType.java?rev=1521121&r1=1521120&r2=1521121&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsType.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsType.java Mon Sep 9 14:16:55 2013
@@ -87,7 +87,7 @@ public class RsType {
/**
* returns the Features for a type in a result spec
* @param ts The type system, may be null
- * @return
+ * @return list of features for a type in a result spec
*/
List<Feature> getAllAppropriateFeatures(final TypeSystem ts) {
if (null == ts) {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/TypeOrFeature_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/TypeOrFeature_impl.java?rev=1521121&r1=1521120&r2=1521121&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/TypeOrFeature_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/TypeOrFeature_impl.java Mon Sep 9 14:16:55 2013
@@ -167,7 +167,7 @@ public class TypeOrFeature_impl extends
}
/**
- * @see org.apache.uima.resource.impl.MetaDataObject_impl#getXmlizationInfo()
+ * @see org.apache.uima.resource.metadata.impl.MetaDataObject_impl#getXmlizationInfo()
*/
protected XmlizationInfo getXmlizationInfo() {
return new XmlizationInfo(null, null);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/UimacppAnalysisEngineImpl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/UimacppAnalysisEngineImpl.java?rev=1521121&r1=1521120&r2=1521121&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/UimacppAnalysisEngineImpl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/UimacppAnalysisEngineImpl.java Mon Sep 9 14:16:55 2013
@@ -244,7 +244,7 @@ public class UimacppAnalysisEngineImpl e
}
/**
- * @see org.apache.uima.resource.AnalysisEngine#reconfigure()
+ * @see org.apache.uima.analysis_engine.AnalysisEngine#reconfigure()
*/
public void reconfigure() throws ResourceConfigurationException {
// do base resource reconfiguration
@@ -258,10 +258,6 @@ public class UimacppAnalysisEngineImpl e
*
* @param aCAS
* CAS to be processed by annotator
- * @param aResultSpec
- * result specification to be passed to annotator
- * @param aProcessTrace
- * keeps track of time spent in each component
*/
protected void callAnalysisComponentProcess(CAS aCAS) throws AnalysisEngineProcessException {
// logging and instrumentation
@@ -312,12 +308,6 @@ public class UimacppAnalysisEngineImpl e
/**
* A utility method that performs initialization logic for a primitive AnalysisEngine.
*
- * @param aDescription
- * the AnalysisEngine description for this AnalysisEngine
- * @param aConfigParamSettings
- * the configuration parameter settings that are the result of merging this primitive
- * AE's parameter settings with those specified in any enclosing aggregate AE.
- *
* @throws ResourceInitializationException
* if an initialization failure occurs
*/