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/12/09 19:26:58 UTC
svn commit: r1549636 - in
/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima: cas/text/
collection/ collection/base_cpm/ collection/impl/
Author: schor
Date: Mon Dec 9 18:26:57 2013
New Revision: 1549636
URL: http://svn.apache.org/r1549636
Log:
[UIMA-3484] javadoc fixes
Modified:
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CasInitializer.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CollectionProcessingEngine.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CollectionProcessingManager.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/BaseCPM.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/BaseCollectionReader.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasObjectProcessor.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/impl/CollectionReaderDescription_impl.java
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java?rev=1549636&r1=1549635&r2=1549636&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java Mon Dec 9 18:26:57 2013
@@ -26,7 +26,7 @@ import org.apache.uima.cas.FSIterator;
* An annotation index provides additional iterator functionality that applies only to instances of
* <code>uima.tcas.Annotation</code>. You can obtain an AnnotationIndex by calling:
* <p>
- * <code>AnnotationIndex idx = (AnnotationIndex)cas.getAnnotationIndex();</code> <br/>(the
+ * <code>AnnotationIndex idx = (AnnotationIndex)cas.getAnnotationIndex();</code> <br>(the
* typecast is necessary for historical reasons).
* </p>
* <p>
@@ -49,6 +49,8 @@ import org.apache.uima.cas.FSIterator;
* have two annotations of the exact same type that also have the same span. It will also occur if
* you have not defined any type priority between two annotations that have the same span.</li>
* </ul>
+ * </p>
+ * <p>
* In the method descriptions below, the notation <code>a < b</code>, where <code>a</code>
* and <code>b</code> are annotations, should be taken to mean <code>a</code> comes before
* <code>b</code> in the index, according to the above rules.
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CasInitializer.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CasInitializer.java?rev=1549636&r1=1549635&r2=1549636&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CasInitializer.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CasInitializer.java Mon Dec 9 18:26:57 2013
@@ -47,6 +47,7 @@ public interface CasInitializer extends
* Type and Features to the actual {@link org.apache.uima.cas.Type} and
* {@link org.apache.uima.cas.Feature} objects, which can then be used during processing.
*
+ * @param aTypeSystem the type system to use
* @throws ResourceInitializationException
* if the type system is not compatible with this CAS Initializer
*/
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CollectionProcessingEngine.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CollectionProcessingEngine.java?rev=1549636&r1=1549635&r2=1549636&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CollectionProcessingEngine.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CollectionProcessingEngine.java Mon Dec 9 18:26:57 2013
@@ -118,7 +118,7 @@ public interface CollectionProcessingEng
/**
* Determines whether this CPE is currently processing. This means that a processing request has
* been submitted and has not yet completed or been {@link #stop()}ped. If processing is paused,
- * this method will still return <code>true<code>.
+ * this method will still return <code>true</code>.
*
* @return true if and only if this CPE is currently processing.
*/
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CollectionProcessingManager.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CollectionProcessingManager.java?rev=1549636&r1=1549635&r2=1549636&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CollectionProcessingManager.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CollectionProcessingManager.java Mon Dec 9 18:26:57 2013
@@ -74,7 +74,7 @@ public interface CollectionProcessingMan
* the <code>AnalysisEngine</code> that this CPM will use to analyze each CAS in the
* collection.
*
- * @throws org.apache.uima.UIMA_IllegalStateException
+ * @throws ResourceConfigurationException
* if this CPM is currently processing
*/
public void setAnalysisEngine(AnalysisEngine aAnalysisEngine)
@@ -93,7 +93,7 @@ public interface CollectionProcessingMan
* @param aCasConsumer
* a <code>CasConsumer</code> to add
*
- * @throws org.apache.uima.UIMA_IllegalStateException
+ * @throws ResourceConfigurationException
* if this CPM is currently processing
*/
public void addCasConsumer(CasConsumer aCasConsumer) throws ResourceConfigurationException;
@@ -211,7 +211,7 @@ public interface CollectionProcessingMan
/**
* Determines whether this CPM is currently processing. This means that a processing request has
* been submitted and has not yet completed or been {@link #stop()}ped. If processing is paused,
- * this method will still return <code>true<code>.
+ * this method will still return <code>true</code>.
*
* @return true if and only if this CPM is currently processing.
*/
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/BaseCPM.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/BaseCPM.java?rev=1549636&r1=1549635&r2=1549636&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/BaseCPM.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/BaseCPM.java Mon Dec 9 18:26:57 2013
@@ -95,7 +95,7 @@ public interface BaseCPM {
* @param aCasProcessor
* a <code>CasProcessor</code> to add
*
- * @throws org.apache.uima.UIMA_IllegalStateException
+ * @throws ResourceConfigurationException
* if this CPM is currently processing
*/
public void addCasProcessor(CasProcessor aCasProcessor) throws ResourceConfigurationException;
@@ -109,10 +109,8 @@ public interface BaseCPM {
* @param aIndex
* the index at which to add the CasProcessor
*
- * @throws org.apache.uima.UIMA_IllegalStateException
+ * @throws ResourceConfigurationException
* if this CPM is currently processing
- * @throws IndexOutOfBoundsException
- * if aIndex is out of range
*/
public void addCasProcessor(CasProcessor aCasProcessor, int aIndex)
throws ResourceConfigurationException;
@@ -123,8 +121,6 @@ public interface BaseCPM {
* @param aCasProcessor
* the <code>CasProcessor</code> to remove
*
- * @throws org.apache.uima.UIMA_IllegalStateException
- * if this CPM is currently processing
*/
public void removeCasProcessor(CasProcessor aCasProcessor);
@@ -134,10 +130,6 @@ public interface BaseCPM {
* @param aCasProcessorName
* the name of the <code>CasProcessor</code> to disable
*
- * @throws UIMA_IllegalStateException
- * if this CPM is currently processing
- * @throws IOException
- * if an I/O failure occurs
*/
public void disableCasProcessor(String aCasProcessorName);
@@ -159,8 +151,6 @@ public interface BaseCPM {
* @param aRequired
* true if and only if serial processing is required
*
- * @throws org.apache.uima.UIMA_IllegalStateException
- * if this CPM is currently processing
*/
public void setSerialProcessingRequired(boolean aRequired);
@@ -179,8 +169,6 @@ public interface BaseCPM {
* @param aPause
* true if and only if this CPM should pause on exception
*
- * @throws org.apache.uima.UIMA_IllegalStateException
- * if this CPM is currently processing
*/
public void setPauseOnException(boolean aPause);
@@ -212,15 +200,13 @@ public interface BaseCPM {
*
* @throws ResourceInitializationException
* if an error occurs during initialization
- * @throws org.apache.uima.UIMA_IllegalStateException
- * if this CPM is currently processing
*/
public void process() throws ResourceInitializationException;
/**
* Determines whether this CPM is currently processing. This means that a processing request has
* been submitted and has not yet completed or been {@link #stop()}ped. If processing is paused,
- * this method will still return <code>true<code>.
+ * this method will still return <code>true</code>.
*
* @return true if and only if this CPM is currently processing.
*/
@@ -230,8 +216,6 @@ public interface BaseCPM {
* Pauses processing. Processing can later be resumed by calling the {@link #resume(boolean)}
* method.
*
- * @throws org.apache.uima.UIMA_IllegalStateException
- * if no processing is currently occuring
*/
public void pause();
@@ -252,24 +236,18 @@ public interface BaseCPM {
* <code>false</code> (the default) will cause processing to continue with the next
* entity after the failure.
*
- * @throws org.apache.uima.UIMA_IllegalStateException
- * if processing is not currently paused
*/
public void resume(boolean aRetryFailed);
/**
* Resumes processing that has been paused.
*
- * @throws org.apache.uima.UIMA_IllegalStateException
- * if processing is not currently paused
*/
public void resume();
/**
* Stops processing.
*
- * @throws org.apache.uima.UIMA_IllegalStateException
- * if no processing is currently occuring
*/
public void stop();
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/BaseCollectionReader.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/BaseCollectionReader.java?rev=1549636&r1=1549635&r2=1549636&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/BaseCollectionReader.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/BaseCollectionReader.java Mon Dec 9 18:26:57 2013
@@ -61,7 +61,7 @@ public interface BaseCollectionReader ex
* <code>CollectionReader</code>s remove each element from the <code>Collection</code> as it
* is read.
*
- * @return true if and only if this is a consuming <code>CollectionReader<code>
+ * @return true if and only if this is a consuming <code>CollectionReader</code>
*/
public boolean isConsuming();
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasObjectProcessor.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasObjectProcessor.java?rev=1549636&r1=1549635&r2=1549636&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasObjectProcessor.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasObjectProcessor.java Mon Dec 9 18:26:57 2013
@@ -63,7 +63,8 @@ public interface CasObjectProcessor exte
* and Features to the actual {@link org.apache.uima.cas.Type} and
* {@link org.apache.uima.cas.Feature} objects, which can then be used during processing.
*
- * @throws ResourceInitializatinException
+ * @param aTypeSystem the type system to use
+ * @throws ResourceInitializationException
* if the type system is not compatible with this Cas Consumer
*/
public void typeSystemInit(TypeSystem aTypeSystem) throws ResourceInitializationException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/impl/CollectionReaderDescription_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/impl/CollectionReaderDescription_impl.java?rev=1549636&r1=1549635&r2=1549636&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/impl/CollectionReaderDescription_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/impl/CollectionReaderDescription_impl.java Mon Dec 9 18:26:57 2013
@@ -39,12 +39,7 @@ import org.apache.uima.util.XMLParser;
import org.apache.uima.util.XMLParser.ParsingOptions;
import org.w3c.dom.Element;
-/**
- *
- *
- * To change the template for this generated type comment go to Window>Preferences>Java>Code
- * Generation>Code and Comments
- */
+
public class CollectionReaderDescription_impl extends ResourceCreationSpecifier_impl implements
CollectionReaderDescription {