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/04 12:47:10 UTC
svn commit: r940799 - in
/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima:
./ analysis_engine/ analysis_engine/annotator/ analysis_engine/asb/ cas/
cas/impl/ collection/metadata/ flow/ jcas/ jcas/cas/ pear/tools/ resource/
searc...
Author: schor
Date: Tue May 4 10:47:09 2010
New Revision: 940799
URL: http://svn.apache.org/viewvc?rev=940799&view=rev
Log:
[UIMA-1778] correct bad javadoc comments reported by running Javadoc
Modified:
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/InternationalizedException.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/UIMAFramework.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/UimaContextAdmin.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngine.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngineDescription.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngineServiceStub.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/annotator/package.html
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/asb/ASB.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/FSBooleanConstraint.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/FeatureStructure.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/Marker.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiCasDeserializer.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiCasSerializer.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiSerializationSharedData.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CasProcessorMaxRestarts.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeCollectionReaderIterator.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeSofaMapping.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeSofaMappings.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/flow/ParallelStep.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/flow/SimpleStep.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/flow/SimpleStepWithResultSpec.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/JCas.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/BooleanArray_Type.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ByteArray_Type.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/DoubleArray_Type.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/LongArray_Type.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ShortArray_Type.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/pear/tools/InstallationController.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/resource/CasManager.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/resource/ResourceCreationSpecifier.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/search/IndexBuildSpecification.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/search/Style.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppAnalysisComponent.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/CasCopier.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/CasCreationUtils.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/InstrumentationFacility.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/XMLParser.java
uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/XmlCasSerializer.java
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/InternationalizedException.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/InternationalizedException.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/InternationalizedException.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/InternationalizedException.java Tue May 4 10:47:09 2010
@@ -270,7 +270,7 @@ public class InternationalizedException
*
* @param messageKey
* to search for in the exception chain
- * @return
+ * @return true if this exception or any of its root causes has a particular UIMA message key.
*/
public boolean hasMessageKey(String messageKey) {
if (messageKey.equals(this.getMessageKey())) {
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/UIMAFramework.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/UIMAFramework.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/UIMAFramework.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/UIMAFramework.java Tue May 4 10:47:09 2010
@@ -950,7 +950,7 @@ public abstract class UIMAFramework {
}
/**
- * Gets a new instance of the default {@link ResourceManagerPearWrapper} used by this implementation.
+ * Gets a new instance of the default {@link org.apache.uima.resource.ResourceManagerPearWrapper} used by this implementation.
*
* @return a new <code>ResourceManagerPearWrapper</code> to be used by the application.
*/
@@ -1139,7 +1139,7 @@ public abstract class UIMAFramework {
/**
* To be implemented by subclasses; this should return a new instance of the default
- * {@link ResourceManagerPearWrapper} used by this implementation.
+ * {@link org.apache.uima.resource.ResourceManagerPearWrapper} used by this implementation.
*
* @return a new <code>ResourceManagerPearWrapper</code> to be used by the application.
*/
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/UimaContextAdmin.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/UimaContextAdmin.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/UimaContextAdmin.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/UimaContextAdmin.java Tue May 4 10:47:09 2010
@@ -113,8 +113,6 @@ public interface UimaContextAdmin extend
* created. In a multi-client deployment, the deployment wrapper is responsible for ensuring that
* an appropriate Session object is installed here prior to invoking components that use this
* UimaContext.
- *
- * @return the Session object for the current client
*/
public void setSession(Session aSession);
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngine.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngine.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngine.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngine.java Tue May 4 10:47:09 2010
@@ -199,7 +199,7 @@ public interface AnalysisEngine extends
* <p>
* Note that the CAS allows multiple subjects of analysis (e.g. documents) and defines a separate
* "view" for each of them. If your application wants to work with a single subject of analysis,
- * call the method {@link CAS#getDefaultView()} and operate on the returned view.
+ * call the method {@link CAS#getCurrentView()} and operate on the returned view.
*
* @return a new <code>CAS</code> appropriate for this AnalysisEngine.
*
@@ -215,7 +215,7 @@ public interface AnalysisEngine extends
* {@link JCas} interface.
* <p>
* Note: the JCas that is returned is equivalent to what you would get if you called
- * <code>newCAS().getDefaultView().getJCas()</code>. That is, this method returns a view of the
+ * <code>newCAS().getCurrentView().getJCas()</code>. That is, this method returns a view of the
* default Sofa, NOT a Base CAS.
* <p>
* <b>Important:</b> CAS creation is expensive, so if at all possible an application should reuse
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngineDescription.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngineDescription.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngineDescription.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngineDescription.java Tue May 4 10:47:09 2010
@@ -100,7 +100,7 @@ public interface AnalysisEngineDescripti
* Some of the methods on this class apply only to one type of AnalysisEngine:<br>
* {@link #getAnnotatorImplementationName()} - primitive AnalysisEngine only<br>
* {@link #getDelegateAnalysisEngineSpecifiers()} - aggregate AnalysisEngine only<br>
- * {@link #getFlowController()} - aggregate AnalysisEngine only<br>
+ * {@link #getFlowControllerDeclaration()} - aggregate AnalysisEngine only<br>
* <p>
*
* @return true if and only if the AnalysisEngine is primitive
@@ -245,7 +245,7 @@ public interface AnalysisEngineDescripti
* Note that the Map returned by this method will never contain
* {@link org.apache.uima.resource.metadata.Import} objects -- they will always be resolved first.
* If you want to get access to the original Import objects, use
- * {@link #getDelegateAnalysisEngineSpecifiersWithImports()} and {@link #getFlowController()}.
+ * {@link #getDelegateAnalysisEngineSpecifiersWithImports()} and {@link #getFlowControllerDeclaration()}.
* Also use those methods if you want to make changes to be able to make changes to the Map.
*
* @param aResourceManager
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngineServiceStub.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngineServiceStub.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngineServiceStub.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngineServiceStub.java Tue May 4 10:47:09 2010
@@ -34,8 +34,6 @@ public interface AnalysisEngineServiceSt
*
* @param aCAS
* the CAS to process
- *
- * @return metadata for the Analysis Engine
*/
public abstract void callProcess(CAS aCAS) throws ResourceServiceException;
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/annotator/package.html
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/annotator/package.html?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/annotator/package.html (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/annotator/package.html Tue May 4 10:47:09 2010
@@ -31,7 +31,7 @@ and exception classes.</p>
<li><code>{@link org.apache.uima.analysis_engine.annotator.TextAnnotator}</code>: an annotator that
processes text documents.</li>
<li><code>{@link org.apache.uima.analysis_engine.annotator.JTextAnnotator}</code>: similar to
- <code>TextAnnotator</code>, but uses the Java-object-based {@link org.apache.uima.jcas.impl.JCas}
+ <code>TextAnnotator</code>, but uses the Java-object-based {@link org.apache.uima.jcas.JCas}
interface instead of the standard {@link org.apache.uima.cas.CAS} interface. </li>
</ul>
</p>
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/asb/ASB.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/asb/ASB.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/asb/ASB.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/analysis_engine/asb/ASB.java Tue May 4 10:47:09 2010
@@ -90,7 +90,7 @@ public interface ASB extends Resource {
* {@link AnalysisEngineMetaData} values.
*
* @throws org.apache.uima.UIMA_IllegalStateException
- * if {@link #setup()} has not been called yet.
+ * if {@link #setup(Map, UimaContextAdmin, FlowControllerDeclaration, AnalysisEngineMetaData)} has not been called yet.
*/
public Map<String, AnalysisEngineMetaData> getComponentAnalysisEngineMetaData();
@@ -111,7 +111,7 @@ public interface ASB extends Resource {
* {@link AnalysisEngine} objects.
*
* @throws org.apache.uima.UIMA_IllegalStateException
- * if {@link #setup()} has not been called yet.
+ * if {@link #setup(Map, UimaContextAdmin, FlowControllerDeclaration, AnalysisEngineMetaData)} has not been called yet.
*/
public Map<String, AnalysisEngine> getComponentAnalysisEngines();
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java Tue May 4 10:47:09 2010
@@ -881,7 +881,7 @@ public interface CAS extends AbstractCas
*
* @param text
* The text to be analyzed.
- * @param mime
+ * @param mimetype
* The mime type of the data
* @exception CASRuntimeException
* If the Sofa data has already been set.
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/FSBooleanConstraint.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/FSBooleanConstraint.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/FSBooleanConstraint.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/FSBooleanConstraint.java Tue May 4 10:47:09 2010
@@ -24,7 +24,7 @@ package org.apache.uima.cas;
* Interface for a boolean constraint. A boolean constraint contains a single condition, either true
* or false. To set the condition, use
* <p>
- * To use the constraint, invoke its {@link #match(float)} method, passing the value to test. You
+ * To use the constraint, invoke its {@link #match(boolean)} method, passing the value to test. You
* can also embed this test with a path specification, using the
* {@link org.apache.uima.cas.ConstraintFactory#embedConstraint(FeaturePath, FSConstraint)} method,
* and use it to test feature structures, or combine it with other tests using the
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/FeatureStructure.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/FeatureStructure.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/FeatureStructure.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/FeatureStructure.java Tue May 4 10:47:09 2010
@@ -272,8 +272,8 @@ public interface FeatureStructure {
* Sets the value of a feature from a string input if the feature type is one of the primitive
* types.
*
- * @param featThe
- * feature whose value we want to set.
+ * @param feat
+ * The feature whose value we want to set.
* @param s
* The string value that the feature will be set to.
* @throws CASRuntimeException
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/Marker.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/Marker.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/Marker.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/Marker.java Tue May 4 10:47:09 2010
@@ -27,25 +27,22 @@ package org.apache.uima.cas;
public interface Marker {
/**
- * Returns true if a <code>FeatureStructure</code> was created after the mark represented by this <code>Marker</code> object.
* @param fs
- * @return
+ * @return true if a <code>FeatureStructure</code> was created after the mark represented by this <code>Marker</code> object.
*/
boolean isNew(FeatureStructure fs);
/**
- * Returns true if a <code>FeatureStructure</code> that existed prior to the mark
* represented by this <code>Markere</code> is modified.
* @param fs
- * @return boolean
+ * @return true if a <code>FeatureStructure</code> that existed prior to the mark
*/
boolean isModified(FeatureStructure fs);
/**
- * Return true if the Marker is still valid.
* A Marker becomes invalid when the <code>CAS</code> from which it was obtained
* is reset.
- * @return
+ * @return true if the Marker is still valid.
*/
boolean isValid();
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiCasDeserializer.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiCasDeserializer.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiCasDeserializer.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiCasDeserializer.java Tue May 4 10:47:09 2010
@@ -2010,11 +2010,11 @@ public class XmiCasDeserializer {
*
*/
public static void deserialize(InputStream aStream, CAS aCAS, boolean aLenient,
- XmiSerializationSharedData aSharedData, int aMergePoint, AllowPreexistingFS allowPreexistngFS)
+ XmiSerializationSharedData aSharedData, int aMergePoint, AllowPreexistingFS allowPreexistingFS)
throws SAXException, IOException {
XMLReader xmlReader = XMLReaderFactory.createXMLReader();
XmiCasDeserializer deser = new XmiCasDeserializer(aCAS.getTypeSystem());
- ContentHandler handler = deser.getXmiCasHandler(aCAS, aLenient, aSharedData, aMergePoint, allowPreexistngFS);
+ ContentHandler handler = deser.getXmiCasHandler(aCAS, aLenient, aSharedData, aMergePoint, allowPreexistingFS);
xmlReader.setContentHandler(handler);
xmlReader.parse(new InputSource(aStream));
}
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiCasSerializer.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiCasSerializer.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiCasSerializer.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiCasSerializer.java Tue May 4 10:47:09 2010
@@ -1394,7 +1394,7 @@ public class XmiCasSerializer {
* the <code>serialize</code> method that contains types and features that are not in
* this typesystem, the serialization will not contain instances of those types or values
* for those features. So this can be used to filter the results of serialization.
- * @param nsUriToSchemaLocation
+ * @param nsUriToSchemaLocationMap
* Map if supplied, this map is used to generate a "schemaLocation" attribute in the XMI
* output. This argument must be a map from namespace URIs to the schema location for
* that namespace URI.
@@ -1431,7 +1431,7 @@ public class XmiCasSerializer {
* for those features. So this can be used to filter the results of serialization.
* @param uimaContext
* not used
- * @param nsUriToSchemaLocation
+ * @param nsUriToSchemaLocationMap
* Map if supplied, this map is used to generate a "schemaLocation" attribute in the XMI
* output. This argument must be a map from namespace URIs to the schema location for
* that namespace URI.
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiSerializationSharedData.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiSerializationSharedData.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiSerializationSharedData.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/cas/impl/XmiSerializationSharedData.java Tue May 4 10:47:09 2010
@@ -182,9 +182,9 @@ public class XmiSerializationSharedData
}
/**
- * Gets a List of {@link OotsElementData} objects, each of which describes an
+ * Gets a List of {@link org.apache.uima.cas.impl.XmiSerializationSharedData.OotsElementData} objects, each of which describes an
* incoming XMI element that did not correspond to a Type in the TypeSystem.
- * @return List of {@link OotsElementData} objects
+ * @return List of {@link org.apache.uima.cas.impl.XmiSerializationSharedData.OotsElementData} objects
*/
public List<OotsElementData> getOutOfTypeSystemElements() {
return Collections.unmodifiableList(this.ootsFs);
@@ -239,7 +239,7 @@ public class XmiSerializationSharedData
* These will be added to the child elements when that FS is reserialized.
* @param addr CAS address of the FS
* @param featName name of the feature (element tag name)
- * @param featVal values of the feature, as a List of strings
+ * @param featVals values of the feature, as a List of strings
*/
public void addOutOfTypeSystemChildElements(int addr, String featName, List<String> featVals) {
Integer key = Integer.valueOf(addr);
@@ -278,7 +278,7 @@ public class XmiSerializationSharedData
/**
* Gets information about out-of-typesystem array elements.
* @param addr the CAS address of an FSArray
- * @return a List of {@link XmiArrayElement} objects, each of which
+ * @return a List of {@link org.apache.uima.cas.impl.XmiSerializationSharedData.XmiArrayElement} objects, each of which
* holds the index and xmi:id of an array element that is a
* reference to an out-of-typesystem FS.
*/
@@ -316,7 +316,7 @@ public class XmiSerializationSharedData
/**
*
- * @return
+ * @return the non-shared featureId to FS Id key set
*/
public int[] getNonsharedMulitValuedFSs() {
return this.nonsharedfeatureIdToFSId.keySet();
@@ -325,7 +325,7 @@ public class XmiSerializationSharedData
/**
*
* @param nonsharedFS
- * @return
+ * @return the int handle to the encompassing FS
*/
public int getEncompassingFS(int nonsharedFS) {
Integer addr = (Integer) this.nonsharedfeatureIdToFSId.get(nonsharedFS);
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CasProcessorMaxRestarts.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CasProcessorMaxRestarts.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CasProcessorMaxRestarts.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CasProcessorMaxRestarts.java Tue May 4 10:47:09 2010
@@ -25,8 +25,6 @@ import org.apache.uima.resource.metadata
* An object that holds configuration related to handling max restarts for CasProcessors. It
* provides the means of configuring threshold for max restart tolerance, and defining a strategy to
* apply when thresholds are exceeded. Used when constucting a CPE descriptor.
- *
- *
*/
public interface CasProcessorMaxRestarts extends MetaDataObject {
/**
@@ -71,12 +69,12 @@ public interface CasProcessorMaxRestarts
/**
*
- * @return
+ * @return the wait time between successive retries
*/
public int getWaitTimeBetweenRetries();
/**
- * @param i
+ * @param i time to wait between successive retries
*/
public void setWaitTimeBetweenRetries(int i);
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeCollectionReaderIterator.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeCollectionReaderIterator.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeCollectionReaderIterator.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeCollectionReaderIterator.java Tue May 4 10:47:09 2010
@@ -27,10 +27,8 @@ import org.apache.uima.resource.metadata
*
*/
public interface CpeCollectionReaderIterator extends MetaDataObject {
- /**
- * Return Descriptor
- *
- * @return
+ /**
+ * @return Descriptor
*/
public CpeComponentDescriptor getDescriptor();
@@ -42,10 +40,8 @@ public interface CpeCollectionReaderIter
public void setDescriptor(CpeComponentDescriptor descriptor);
/**
- * Return override parameters. These override parameters in the Collection Reader component
- * descriptor.
- *
- * @return
+ * @return override parameters. These override parameters in the Collection Reader component
+ * descriptor.
*/
public CasProcessorConfigurationParameterSettings getConfigurationParameterSettings();
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeSofaMapping.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeSofaMapping.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeSofaMapping.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeSofaMapping.java Tue May 4 10:47:09 2010
@@ -25,7 +25,7 @@ public interface CpeSofaMapping extends
public String getComponentSofaName();
/**
- * @return
+ * @return Sofa Name
*/
public String getCpeSofaName();
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeSofaMappings.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeSofaMappings.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeSofaMappings.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeSofaMappings.java Tue May 4 10:47:09 2010
@@ -25,14 +25,14 @@ public interface CpeSofaMappings extends
/**
* Return Sofa Name Mappings
*
- * @return
+ * @return an array of Sofa Mappings
*/
public CpeSofaMapping[] getSofaNameMappings();
/**
* Set Sofa Name Mappings
*
- * @param sofaMappings
+ * @param sofaMappings an array of sofaMappings
*/
public void setSofaNameMappings(CpeSofaMapping[] sofaMappings);
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/flow/ParallelStep.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/flow/ParallelStep.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/flow/ParallelStep.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/flow/ParallelStep.java Tue May 4 10:47:09 2010
@@ -61,7 +61,7 @@ public class ParallelStep extends Step {
* a user's Flow implementation can (but is not required to) reuse the same ParallelStep object
* multiple times.
*
- * @return A Collection of Strings, where each String is the key of an Analysis Engine to which the CAS
+ * @param aKeys A Collection of Strings, where each String is the key of an Analysis Engine to which the CAS
* should be routed. Each String must bee one of the keys in the FlowController's
* {@link FlowControllerContext#getAnalysisEngineMetaDataMap()}.
*/
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/flow/SimpleStep.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/flow/SimpleStep.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/flow/SimpleStep.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/flow/SimpleStep.java Tue May 4 10:47:09 2010
@@ -28,7 +28,7 @@ public class SimpleStep extends Step {
/**
* Creates a new SimpleStep
*
- * @param aAnalysisEngineKey
+ * @param aCasProcessorKey
* The key of the Analysis Engine to which the CAS should be routed. This must be one of
* the keys in the FlowController's
* {@link FlowControllerContext#getAnalysisEngineMetaDataMap()}.
@@ -51,7 +51,7 @@ public class SimpleStep extends Step {
* user's Flow implementation can (but is not required to) reuse the same SimpleStep object
* multiple times.
*
- * @return an Analysis Engine key. This must be one of the keys in the FlowController's
+ * @param aKey an Analysis Engine key. This must be one of the keys in the FlowController's
* {@link FlowControllerContext#getAnalysisEngineMetaDataMap()}.
*/
public void setAnalysisEngineKey(String aKey) {
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/flow/SimpleStepWithResultSpec.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/flow/SimpleStepWithResultSpec.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/flow/SimpleStepWithResultSpec.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/flow/SimpleStepWithResultSpec.java Tue May 4 10:47:09 2010
@@ -33,8 +33,8 @@ import org.apache.uima.analysis_engine.R
public class SimpleStepWithResultSpec extends SimpleStep {
/**
- * @param casProcessorKey
- * @param currentAnalysisResultSpec
+ * @param aCasProcessorKey
+ * @param aResultSpec
*/
public SimpleStepWithResultSpec(String aCasProcessorKey, ResultSpecification aResultSpec) {
super(aCasProcessorKey);
@@ -42,21 +42,18 @@ public class SimpleStepWithResultSpec ex
}
/**
- * Gets the key of the Analysis Engine to which the CAS should be routed.
+ * Gets the results specification
*
- * @return an AnalysisEngine key
+ * @return the results specification
*/
public ResultSpecification getResultSpecification() {
return mResultSpec;
}
/**
- * Sets the key of the Analysis Engine to which the CAS should be routed. By using this method, a
- * user's Flow implementation can (but is not required to) reuse the same SimpleStep object
- * multiple times.
+ * Sets the results specification
*
- * @return an Analysis Engine key. This must be one of the keys in the FlowController's
- * {@link FlowControllerContext#getAnalysisEngineMetaDataMap()}.
+ * @param aResultSpec the results specification to set
*/
public void setResultSpecification(ResultSpecification aResultSpec) {
mResultSpec = aResultSpec;
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/JCas.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/JCas.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/JCas.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/JCas.java Tue May 4 10:47:09 2010
@@ -185,8 +185,8 @@ public interface JCas extends AbstractCa
* {@link #setSofaDataString(String, String)} or {@link #setSofaDataURI(String, String)} on the
* JCas view returned by this method.
*
- * @param localViewName
- * the local name, before any sofa name mapping is done, for this view (note: this is the
+ * @param sofaID
+ * the local view name, before any sofa name mapping is done, for this view (note: this is the
* same as the associated Sofa name).
*
* @return The view corresponding to this local name.
@@ -198,7 +198,7 @@ public interface JCas extends AbstractCa
/**
* Create a JCas view for a Sofa.
*
- * @param aSofa
+ * @param sofa
* a Sofa feature structure in this CAS.
*
* @return The JCas view for the given Sofa.
@@ -433,7 +433,7 @@ public interface JCas extends AbstractCa
*
* @param text
* The text to be analyzed.
- * @param mime
+ * @param mimetype
* The mime type of the data
* @exception CASRuntimeException
* If the Sofa data has already been set.
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/BooleanArray_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/BooleanArray_Type.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/BooleanArray_Type.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/BooleanArray_Type.java Tue May 4 10:47:09 2010
@@ -91,7 +91,7 @@ public final class BooleanArray_Type ext
/**
* updates the Cas, setting the indexed value to the passed in Java String value.
*
- * @see org.apache.uima.cas.BooleanArrayFS#set(int, FeatureStructure)
+ * @see org.apache.uima.cas.BooleanArrayFS#set(int, boolean)
*/
public void set(int addr, int i, boolean v) {
if (lowLevelTypeChecks)
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ByteArray_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ByteArray_Type.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ByteArray_Type.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ByteArray_Type.java Tue May 4 10:47:09 2010
@@ -91,7 +91,7 @@ public final class ByteArray_Type extend
/**
* updates the Cas, setting the indexed value to the passed in Java String value.
*
- * @see org.apache.uima.cas.ByteArrayFS#set(int, FeatureStructure)
+ * @see org.apache.uima.cas.ByteArrayFS#set(int, byte)
*/
public void set(int addr, int i, byte v) {
if (lowLevelTypeChecks)
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/DoubleArray_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/DoubleArray_Type.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/DoubleArray_Type.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/DoubleArray_Type.java Tue May 4 10:47:09 2010
@@ -91,7 +91,7 @@ public final class DoubleArray_Type exte
/**
* updates the Cas, setting the indexed value to the passed in Java String value.
*
- * @see org.apache.uima.cas.DoubleArrayFS#set(int, FeatureStructure)
+ * @see org.apache.uima.cas.DoubleArrayFS#set(int, double)
*/
public void set(int addr, int i, double v) {
if (lowLevelTypeChecks)
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/LongArray_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/LongArray_Type.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/LongArray_Type.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/LongArray_Type.java Tue May 4 10:47:09 2010
@@ -91,7 +91,7 @@ public final class LongArray_Type extend
/**
* updates the Cas, setting the indexed value to the passed in Java String value.
*
- * @see org.apache.uima.cas.LongArrayFS#set(int, FeatureStructure)
+ * @see org.apache.uima.cas.LongArrayFS#set(int, long)
*/
public void set(int addr, int i, long v) {
if (lowLevelTypeChecks)
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ShortArray_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ShortArray_Type.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ShortArray_Type.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ShortArray_Type.java Tue May 4 10:47:09 2010
@@ -91,7 +91,7 @@ public final class ShortArray_Type exten
/**
* updates the Cas, setting the indexed value to the passed in Java String value.
*
- * @see org.apache.uima.cas.ShortArrayFS#set(int, FeatureStructure)
+ * @see org.apache.uima.cas.ShortArrayFS#set(int, short)
*/
public void set(int addr, int i, short v) {
if (lowLevelTypeChecks)
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/pear/tools/InstallationController.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/pear/tools/InstallationController.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/pear/tools/InstallationController.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/pear/tools/InstallationController.java Tue May 4 10:47:09 2010
@@ -699,8 +699,6 @@ public class InstallationController {
* Internal implementatiton of the <code>extractFilesFromPEARFile</code> method, which allows
* sending messages to the OUT and ERR queues.
*
- * @param componentId
- * The given component ID.
* @param pearFileLocation
* The given PEAR file location.
* @param fileExt
@@ -839,8 +837,6 @@ public class InstallationController {
* Internal implementation of the <code>extractPEARFile</code> method, which allows sending
* messages to the OUT and ERR queues.
*
- * @param componentId
- * The given component ID.
* @param pearFileLocation
* The given PEAR file location.
* @param installationDir
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/resource/CasManager.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/resource/CasManager.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/resource/CasManager.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/resource/CasManager.java Tue May 4 10:47:09 2010
@@ -61,7 +61,7 @@ public interface CasManager extends CasO
* qualified name of UIMA Contexts passed to {@link #defineCasPool(UimaContextAdmin, int, Properties)}.
* This name is later passed to the {@link #getCas(String)} method, to check out
* CASes from the pool.
- * @param aSize
+ * @param aMinimumSize
* the minimum CAS pool size required
* @param aPerformanceTuningSettings
* settings, including initial CAS heap size, for the AE
@@ -75,10 +75,10 @@ public interface CasManager extends CasO
* Defines the CAS pool required by a particular AnalysisEngine. (The AnalysisEngine must contain
* a CAS Multiplier if it requires a CAS pool.)
*
- * @param aRequestorContextName
+ * @param aRequestorContext
* the UimaContext of the AE that will request the CASes
* (AnalysisEngine.getUimaContextAdmin()).
- * @param aSize
+ * @param aMinimumSize
* the minimum CAS pool size required
* @param aPerformanceTuningSettings
* settings, including initial CAS heap size, for the AE
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/resource/ResourceCreationSpecifier.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/resource/ResourceCreationSpecifier.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/resource/ResourceCreationSpecifier.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/resource/ResourceCreationSpecifier.java Tue May 4 10:47:09 2010
@@ -33,9 +33,9 @@ import org.apache.uima.resource.metadata
* All Resource Creation Specifiers must the following:
* <ul>
* <li><code>frameworkImplementation</code>: The name of the UIMA framework in which the
- * component executes. The name for this implementation is given by {@link Constants.JAVA_FRAMEWORK_NAME}.
+ * component executes. The name for this implementation is given by {@link org.apache.uima.Constants#JAVA_FRAMEWORK_NAME}.
* A component that runs in the C++ enablement layer needs to have the framework name given by
- * {@link Constants.CPP_FRAMEWORK_NAME}.
+ * {@link org.apache.uima.Constants#CPP_FRAMEWORK_NAME}.
* <li>
* <li><code>implementationName</code>: The fully-qualified Java class name of the user's
* component (Annotator, CAS Consumer, Collection Reader, or CAS Initializer).
@@ -55,7 +55,7 @@ import org.apache.uima.resource.metadata
public interface ResourceCreationSpecifier extends ResourceSpecifier {
/**
* Gets the name of the AE framework implementation within which the Resource executes. The
- * framework name for this implementation is given by {@link Constants.JAVA_FRAMEWORK_NAME}..
+ * framework name for this implementation is given by {@link org.apache.uima.Constants#JAVA_FRAMEWORK_NAME}..
*
* @return the framework implementation name
*/
@@ -63,7 +63,7 @@ public interface ResourceCreationSpecifi
/**
* Sets the name of the AE framework implementation within which the <code>ResourceCreationSpecifier</code> executes. The
- * framework name for this implementation is given by {@link Constants.JAVA_FRAMEWORK_NAME}..
+ * framework name for this implementation is given by {@link Constants#JAVA_FRAMEWORK_NAME}..
*
* @param aFrameworkImplementation
* the framework implementation name
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/search/IndexBuildSpecification.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/search/IndexBuildSpecification.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/search/IndexBuildSpecification.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/search/IndexBuildSpecification.java Tue May 4 10:47:09 2010
@@ -71,7 +71,7 @@ import org.apache.uima.util.XMLizable;
* <code>syntax</code> attribute on the <code>filter</code> element. See {@link Filter} for
* details. </li>
* <li>STRING can be any string (although in some contexts this must match a valid CAS feature
- * name). See {@link Attribute} and {@link AttributeMappings} for details.</li>
+ * name). See {@link Attribute} and {@link Mapping} for details.</li>
* </ul>
*
*
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/search/Style.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/search/Style.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/search/Style.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/search/Style.java Tue May 4 10:47:09 2010
@@ -129,7 +129,7 @@ public interface Style extends XMLizable
* Sets the mappings that specify which features (properties) of the annotation should be indexed,
* and under which names.
*
- * @pram aMappings an array of objects that each specify a mapping from a CAS feature name to the
+ * @param aMappings an array of objects that each specify a mapping from a CAS feature name to the
* name under which this feature should be recorded in the index.
*/
public void setAttributeMappings(Mapping[] aMappings);
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppAnalysisComponent.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppAnalysisComponent.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppAnalysisComponent.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppAnalysisComponent.java Tue May 4 10:47:09 2010
@@ -91,8 +91,7 @@ public class UimacppAnalysisComponent ex
/**
* @throws ResourceInitializationException
- * @see org.apache.uima.analysis_engine.annotator.BaseAnnotator#initialize(org.apache.uima.cas.CAS,
- * org.apache.uima.analysis_engine.annotator.AnnotatorContext)
+ * @see org.apache.uima.analysis_component.AnalysisComponent#initialize(org.apache.uima.UimaContext)
*/
public void initialize(UimaContext context) throws ResourceInitializationException {
try {
@@ -171,7 +170,7 @@ public class UimacppAnalysisComponent ex
}
/**
- * @see org.apache.uima.analysis_engine.annotator.BaseAnnotator#typeSystemInit()
+ * @see org.apache.uima.analysis_component.CasAnnotator_ImplBase#typeSystemInit(TypeSystem)
*/
public void typeSystemInit(TypeSystem ts) throws AnnotatorConfigurationException,
AnnotatorInitializationException {
@@ -180,7 +179,7 @@ public class UimacppAnalysisComponent ex
}
/**
- * @see org.apache.uima.analysis_engine.annotator.BaseAnnotator#reconfigure(java.lang.String[])
+ * @see org.apache.uima.analysis_component.AnalysisComponent#reconfigure()
*/
public void reconfigure() {
// destroy engine; it will be reinitialized on next call to process
@@ -193,7 +192,7 @@ public class UimacppAnalysisComponent ex
}
/**
- * @see org.apache.uima.analysis_engine.annotator.BaseAnnotator#process(org.apache.uima.analysis_engine.ResultSpecification)
+ * @see org.apache.uima.analysis_engine.annotator.GenericAnnotator#process(CAS, ResultSpecification)
*/
public void process(CAS cas, ResultSpecification aResultSpec) throws AnnotatorProcessException {
try {
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/CasCopier.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/CasCopier.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/CasCopier.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/CasCopier.java Tue May 4 10:47:09 2010
@@ -280,10 +280,8 @@ public class CasCopier {
}
/**
- * Returns whether the given FS has already been copied using this CasCopier.
- *
- * @param aFS
- * @return
+ * @param aFS a feature structure
+ * @return true if the given FS has already been copied using this CasCopier.
*/
public boolean alreadyCopied(FeatureStructure aFS) {
return mFsMap.containsKey(aFS);
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/CasCreationUtils.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/CasCreationUtils.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/CasCreationUtils.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/CasCreationUtils.java Tue May 4 10:47:09 2010
@@ -1690,7 +1690,7 @@ public class CasCreationUtils {
* service will be queries for its metadata. An exception will be thrown if the connection can not
* be opened.
*
- * @param aComponentDescriptionsOrMetaData
+ * @param aComponentDescriptionOrMetaData
* a collection of {@link ResourceSpecifier}, {@link ProcessingResourceMetaData},
* {@link TypeSystemDescription}, {@link FsIndexCollection}, or
* {@link TypePriorities} objects.
@@ -1828,7 +1828,7 @@ public class CasCreationUtils {
* service will be queries for its metadata. An exception will be thrown if the connection can not
* be opened.
*
- * @param aComponentDescriptionsOrMetaData
+ * @param aComponentDescriptionOrMetaData
* a collection of {@link ResourceSpecifier}, {@link ProcessingResourceMetaData},
* {@link TypeSystemDescription}, {@link FsIndexCollection}, or
* {@link TypePriorities} objects.
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/InstrumentationFacility.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/InstrumentationFacility.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/InstrumentationFacility.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/InstrumentationFacility.java Tue May 4 10:47:09 2010
@@ -81,8 +81,6 @@ public interface InstrumentationFacility
* duration of the event in milliseconds
* @param aResultMsg
* result message of event
- *
- * @return the new event
*/
public void addEvent(String aResourceName, String aType, String aDescription, int aDuration,
String aResultMsg);
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/XMLParser.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/XMLParser.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/XMLParser.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/XMLParser.java Tue May 4 10:47:09 2010
@@ -59,7 +59,7 @@ import org.w3c.dom.Element;
* using the {@link #addMapping(String,String)} method to specify mappings between XML Element names
* and the class names of the objects to be built from elements with those names. All objects to be
* built by the XML parser must implement {@link XMLizable} and provide an implementation of
- * {@link XMLizable#buildFromXMLElement(Element,XmlParserBak)}.
+ * {@link XMLizable#buildFromXMLElement(Element, XMLParser)}.
* <p>
* Note that we are considering replacing this ad-hoc XML data binding interface with the java
* standard extension JAXB. See <a href="http://java.sun.com/xml/jaxb"> http://java.sun.com/xml/jaxb</a>
@@ -689,7 +689,7 @@ public interface XMLParser {
/**
* Builds an object from its XML DOM representation. This method is not typically called by
* applications. It may be called from within a
- * {@link XMLizable#buildFromXMLElement(Element,XmlParserBak)} method to construct sub-objects.
+ * {@link XMLizable#buildFromXMLElement(Element, XMLParser)} method to construct sub-objects.
*
* @param aElement
* a DOM Element
@@ -704,7 +704,7 @@ public interface XMLParser {
/**
* Builds an object from its XML DOM representation. This method is not typically called by
* applications. It may be called from within a
- * {@link XMLizable#buildFromXMLElement(Element,XmlParserBak)} method to construct sub-objects.
+ * {@link XMLizable#buildFromXMLElement(Element, XMLParser)} method to construct sub-objects.
*
* @param aElement
* a DOM Element
@@ -722,7 +722,7 @@ public interface XMLParser {
/**
* Builds an object from its XML DOM representation. This method is not typically called by
* applications. It may be called from within a
- * {@link XMLizable#buildFromXMLElement(Element,XmlParser)} method to construct sub-objects.
+ * {@link XMLizable#buildFromXMLElement(Element, XMLParser)} method to construct sub-objects.
* <p>
* This method is similar to {@link #buildObject(Element, XMLParser.ParsingOptions)} but can also
* parse primitive-typed objects wrapped as XML elements, such as
@@ -734,7 +734,7 @@ public interface XMLParser {
* option settings
*
* @return an object constructed from the DOM element. This can be either an instance of
- * {@link Xmlizable}, {@link String}, or one of the primitive type wrapper objects (e.g.
+ * {@link XMLizable}, {@link String}, or one of the primitive type wrapper objects (e.g.
* {@link Integer}, {@link Float}, {@link Boolean}).
*
* @throws InvalidXMLException
Modified: uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/XmlCasSerializer.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/XmlCasSerializer.java?rev=940799&r1=940798&r2=940799&view=diff
==============================================================================
--- uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/XmlCasSerializer.java (original)
+++ uima/uimaj/branches/mavenAlign/uimaj-core/src/main/java/org/apache/uima/util/XmlCasSerializer.java Tue May 4 10:47:09 2010
@@ -62,8 +62,7 @@ public abstract class XmlCasSerializer {
* @param aTargetTypeSystem
* type system to which the produced XMI will conform. Any types or features not in the
* target type system will not be serialized.
- * @param aCAS
- * CAS to serialize.
+ *
* @param aStream
* output stream to which to write the XMI document
*