You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by re...@apache.org on 2014/01/21 01:39:18 UTC
svn commit: r1559866 [1/2] - in /uima/uimafit/branches/2.0.x: ./
uimafit-core/src/main/java/org/apache/uima/fit/component/
uimafit-core/src/main/java/org/apache/uima/fit/component/initialize/
uimafit-core/src/main/java/org/apache/uima/fit/descriptor/ u...
Author: rec
Date: Tue Jan 21 00:39:16 2014
New Revision: 1559866
URL: http://svn.apache.org/r1559866
Log:
[UIMA-3559] JDK 8 complains about bad JavaDoc
Modified:
uima/uimafit/branches/2.0.x/ (props changed)
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasAnnotator_ImplBase.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasCollectionReader_ImplBase.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasConsumer_ImplBase.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasFlowController_ImplBase.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasMultiplier_ImplBase.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/ExternalResourceAware.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasAnnotator_ImplBase.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasCollectionReader_ImplBase.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasConsumer_ImplBase.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasFlowController_ImplBase.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasMultiplier_ImplBase.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/ViewCreatorAnnotator.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/initialize/ConfigurationParameterInitializer.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/ConfigurationParameter.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/ExternalResource.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/FsIndex.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/FsIndexCollection.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/FsIndexKey.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/OperationalProperties.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/ResourceMetaData.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/SofaCapability.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/TypeCapability.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/AggregateBuilder.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/AnnotationFactory.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/CapabilityFactory.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/CollectionReaderFactory.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/ConfigurationParameterFactory.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/ExternalResourceFactory.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/FlowControllerFactory.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/FsIndexFactory.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/JCasFactory.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/ResourceMetaDataFactory.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/SofaMappingFactory.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/TypePrioritiesFactory.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/TypeSystemDescriptionFactory.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/initializable/Initializable.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/initializable/InitializableFactory.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/locator/JndiResourceLocator.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/internal/DescriptionUtils.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/internal/ExtendedExternalResourceDescription_impl.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/internal/LegacySupport.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/internal/LegacySupportPlugin.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/internal/MetaDataUtil.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/internal/ReflectionUtil.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/internal/propertyeditors/GetAsTextStringEditor.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/internal/propertyeditors/PropertyEditorUtil.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/pipeline/JCasIterator.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/pipeline/SimplePipeline.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/testing/factory/TokenBuilder.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/util/CasIOUtil.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/util/FSCollectionFactory.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/util/JCasUtil.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/util/LifeCycleUtil.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/util/LocaleUtil.java
uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/util/SimpleNamedResourceManager.java
uima/uimafit/branches/2.0.x/uimafit-cpe/src/main/java/org/apache/uima/fit/cpe/CpeBuilder.java
uima/uimafit/branches/2.0.x/uimafit-cpe/src/main/java/org/apache/uima/fit/cpe/CpePipeline.java
uima/uimafit/branches/2.0.x/uimafit-legacy-support/src/main/java/org/apache/uima/fit/legacy/converter/AnnotationLiteral.java
Propchange: uima/uimafit/branches/2.0.x/
------------------------------------------------------------------------------
Merged /uima/uimafit/trunk:r1559859
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasAnnotator_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasAnnotator_ImplBase.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasAnnotator_ImplBase.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasAnnotator_ImplBase.java Tue Jan 21 00:39:16 2014
@@ -33,6 +33,11 @@ public abstract class CasAnnotator_ImplB
org.apache.uima.analysis_component.CasAnnotator_ImplBase {
private ExtendedLogger logger;
+ /**
+ * Get the logger.
+ *
+ * @return the logger.
+ */
public ExtendedLogger getLogger() {
if (logger == null) {
logger = new ExtendedLogger(getContext());
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasCollectionReader_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasCollectionReader_ImplBase.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasCollectionReader_ImplBase.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasCollectionReader_ImplBase.java Tue Jan 21 00:39:16 2014
@@ -55,6 +55,9 @@ public abstract class CasCollectionReade
/**
* This method should be overwritten by subclasses.
*
+ * @param context
+ * the UIMA context the component is running in
+ *
* @throws ResourceInitializationException
* if a failure occurs during initialization.
*/
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasConsumer_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasConsumer_ImplBase.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasConsumer_ImplBase.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasConsumer_ImplBase.java Tue Jan 21 00:39:16 2014
@@ -36,6 +36,11 @@ public abstract class CasConsumer_ImplBa
org.apache.uima.analysis_component.CasAnnotator_ImplBase {
private ExtendedLogger logger;
+ /**
+ * Get the logger.
+ *
+ * @return the logger.
+ */
public ExtendedLogger getLogger() {
if (logger == null) {
logger = new ExtendedLogger(getContext());
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasFlowController_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasFlowController_ImplBase.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasFlowController_ImplBase.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasFlowController_ImplBase.java Tue Jan 21 00:39:16 2014
@@ -31,6 +31,11 @@ public abstract class CasFlowController_
org.apache.uima.flow.CasFlowController_ImplBase {
private ExtendedLogger logger;
+ /**
+ * Get the logger.
+ *
+ * @return the logger.
+ */
public ExtendedLogger getLogger() {
if (logger == null) {
logger = new ExtendedLogger(getContext());
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasMultiplier_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasMultiplier_ImplBase.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasMultiplier_ImplBase.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/CasMultiplier_ImplBase.java Tue Jan 21 00:39:16 2014
@@ -34,6 +34,11 @@ public abstract class CasMultiplier_Impl
org.apache.uima.analysis_component.CasMultiplier_ImplBase {
private ExtendedLogger logger;
+ /**
+ * Get the logger.
+ *
+ * @return the logger.
+ */
public ExtendedLogger getLogger() {
if (logger == null) {
logger = new ExtendedLogger(getContext());
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/ExternalResourceAware.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/ExternalResourceAware.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/ExternalResourceAware.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/ExternalResourceAware.java Tue Jan 21 00:39:16 2014
@@ -32,7 +32,7 @@ public interface ExternalResourceAware {
* Get the name of the resource. This is set by
* {@link ExternalResourceFactory#bindExternalResource(org.apache.uima.resource.ResourceCreationSpecifier, String, org.apache.uima.resource.ExternalResourceDescription)
* bindExternalResource()} as the parameter {@link ExternalResourceFactory#PARAM_RESOURCE_NAME
- * PARAM_RESOURCE_NAME}. <br/>
+ * PARAM_RESOURCE_NAME}. <br>
* <b>It is mandatory that any resource implementing this interface declares the configuration
* parameter {@link ExternalResourceFactory#PARAM_RESOURCE_NAME PARAM_RESOURCE_NAME}.</b>
*
@@ -42,6 +42,9 @@ public interface ExternalResourceAware {
/**
* Called after the external resources have been initialized.
+ *
+ * @throws ResourceInitializationException
+ * if an problem occurs in the late initialization.
*/
void afterResourcesInitialized() throws ResourceInitializationException;
}
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasAnnotator_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasAnnotator_ImplBase.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasAnnotator_ImplBase.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasAnnotator_ImplBase.java Tue Jan 21 00:39:16 2014
@@ -32,6 +32,11 @@ public abstract class JCasAnnotator_Impl
org.apache.uima.analysis_component.JCasAnnotator_ImplBase {
private ExtendedLogger logger;
+ /**
+ * Get the logger.
+ *
+ * @return the logger.
+ */
public ExtendedLogger getLogger() {
if (logger == null) {
logger = new ExtendedLogger(getContext());
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasCollectionReader_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasCollectionReader_ImplBase.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasCollectionReader_ImplBase.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasCollectionReader_ImplBase.java Tue Jan 21 00:39:16 2014
@@ -59,6 +59,8 @@ public abstract class JCasCollectionRead
/**
* This method should be overwritten by subclasses.
*
+ * @param context
+ * the UIMA context the component is running in
* @throws ResourceInitializationException
* if a failure occurs during initialization.
*/
@@ -77,6 +79,13 @@ public abstract class JCasCollectionRead
/**
* Subclasses should implement this method rather than {@link #getNext(CAS)}
+ *
+ * @param jCas
+ * the {@link JCas} to store the read data to
+ * @throws IOException
+ * if there was a low-level I/O problem
+ * @throws CollectionException
+ * if there was another problem
*/
public abstract void getNext(JCas jCas) throws IOException, CollectionException;
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasConsumer_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasConsumer_ImplBase.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasConsumer_ImplBase.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasConsumer_ImplBase.java Tue Jan 21 00:39:16 2014
@@ -36,6 +36,11 @@ public abstract class JCasConsumer_ImplB
org.apache.uima.analysis_component.JCasAnnotator_ImplBase {
private ExtendedLogger logger;
+ /**
+ * Get the logger.
+ *
+ * @return the logger.
+ */
public ExtendedLogger getLogger() {
if (logger == null) {
logger = new ExtendedLogger(getContext());
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasFlowController_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasFlowController_ImplBase.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasFlowController_ImplBase.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasFlowController_ImplBase.java Tue Jan 21 00:39:16 2014
@@ -31,6 +31,11 @@ public abstract class JCasFlowController
org.apache.uima.flow.JCasFlowController_ImplBase {
private ExtendedLogger logger;
+ /**
+ * Get the logger.
+ *
+ * @return the logger.
+ */
public ExtendedLogger getLogger() {
if (logger == null) {
logger = new ExtendedLogger(getContext());
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasMultiplier_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasMultiplier_ImplBase.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasMultiplier_ImplBase.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/JCasMultiplier_ImplBase.java Tue Jan 21 00:39:16 2014
@@ -34,6 +34,11 @@ public abstract class JCasMultiplier_Imp
org.apache.uima.analysis_component.JCasMultiplier_ImplBase {
private ExtendedLogger logger;
+ /**
+ * Get the logger.
+ *
+ * @return the logger.
+ */
public ExtendedLogger getLogger() {
if (logger == null) {
logger = new ExtendedLogger(getContext());
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/ViewCreatorAnnotator.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/ViewCreatorAnnotator.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/ViewCreatorAnnotator.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/ViewCreatorAnnotator.java Tue Jan 21 00:39:16 2014
@@ -55,8 +55,15 @@ public class ViewCreatorAnnotator extend
* If the view already exists, it is ok to call this method anyways without worrying about
* checking for this yet.
*
+ * @param aJCas
+ * the {@link JCas} to create the view in
+ * @param aViewName
+ * the name of the new view
* @return true if the view was created as a result of calling this method. false if the view
* already existed.
+ * @throws AnalysisEngineProcessException
+ * if the view could not be created or if an existing view with the given name could not
+ * be accessed
*/
public static JCas createViewSafely(final JCas aJCas, final String aViewName)
throws AnalysisEngineProcessException {
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/initialize/ConfigurationParameterInitializer.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/initialize/ConfigurationParameterInitializer.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/initialize/ConfigurationParameterInitializer.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/component/initialize/ConfigurationParameterInitializer.java Tue Jan 21 00:39:16 2014
@@ -187,6 +187,8 @@ public final class ConfigurationParamete
* @param map
* a UIMA context with configuration parameters.
* @see #initialize(Object, UimaContext)
+ * @throws ResourceInitializationException
+ * if a failure occurs during initialization.
*/
public static void initialize(final Object component, final Map<String, Object> map)
throws ResourceInitializationException {
@@ -208,6 +210,8 @@ public final class ConfigurationParamete
* @param spec
* a resource specifier.
* @see #initialize(Object, UimaContext)
+ * @throws ResourceInitializationException
+ * if a failure occurs during initialization.
*/
public static void initialize(Object component, ResourceSpecifier spec)
throws ResourceInitializationException {
@@ -222,6 +226,8 @@ public final class ConfigurationParamete
* @param parameters
* a list of parameters.
* @see #initialize(Object, UimaContext)
+ * @throws ResourceInitializationException
+ * if a failure occurs during initialization.
*/
public static void initialize(Object component, Parameter... parameters)
throws ResourceInitializationException {
@@ -240,6 +246,8 @@ public final class ConfigurationParamete
* @param parameters
* a list of parameters.
* @see #initialize(Object, UimaContext)
+ * @throws ResourceInitializationException
+ * if a failure occurs during initialization.
*/
public static void initialize(Object component, NameValuePair... parameters)
throws ResourceInitializationException {
@@ -258,6 +266,8 @@ public final class ConfigurationParamete
* @param dataResource
* a data resource with configuration meta data.
* @see #initialize(Object, UimaContext)
+ * @throws ResourceInitializationException
+ * if a failure occurs during initialization.
*/
public static void initialize(Object component, DataResource dataResource)
throws ResourceInitializationException {
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/ConfigurationParameter.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/ConfigurationParameter.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/ConfigurationParameter.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/ConfigurationParameter.java Tue Jan 21 00:39:16 2014
@@ -65,16 +65,22 @@ public @interface ConfigurationParameter
* annotated field as the name of the configuration parameter. The exact name that is used is
* determined by the method
* {@link ConfigurationParameterFactory#getConfigurationParameterName(java.lang.reflect.Field)}
+ *
+ * @return the parameter name.
*/
String name() default USE_FIELD_NAME;
/**
* A description for the configuration parameter
+ *
+ * @return the description.
*/
String description() default "";
/**
* Specifies whether this configuration parameter is mandatory - i.e. the value must be provided
+ *
+ * @return whether this configuration parameter is mandatory.
*/
boolean mandatory() default true;
@@ -96,6 +102,8 @@ public @interface ConfigurationParameter
* <p>
* If you want a field to be initialized with a null value, then do not specify a default value or
* specify the value given by the field {@link #NO_DEFAULT_VALUE}
+ *
+ * @return the default value.
*/
String[] defaultValue() default NO_DEFAULT_VALUE;
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/ExternalResource.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/ExternalResource.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/ExternalResource.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/ExternalResource.java Tue Jan 21 00:39:16 2014
@@ -52,11 +52,15 @@ public @interface ExternalResource {
/**
* A description for the external resource.
+ *
+ * @return the description.
*/
String description() default "";
/**
* Determines if this external resource is mandatory.
+ *
+ * @return if this external resource is mandatory.
*/
boolean mandatory() default true;
}
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/FsIndex.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/FsIndex.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/FsIndex.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/FsIndex.java Tue Jan 21 00:39:16 2014
@@ -52,34 +52,61 @@ public @interface FsIndex {
/**
* @see FsIndexDescription#getLabel()
+ *
+ * @return the label of this index
*/
String label();
/**
+ * The type of the index as name. As an alternative, the index can be defined using a class with
+ * {@link #type()}. One method or the other must be used to set the index type.
+ *
* @see FsIndexDescription#getTypeName()
+ *
+ * @return the type name for this index
*/
String typeName() default NO_NAME_TYPE_SET;
+ /**
+ * The type of the index as class. As an alternative, the index can be defined using a type name
+ * with {@link #typeName()}. One method or the other must be used to set the index type.
+ *
+ * @see FsIndexDescription#getTypeName()
+ *
+ * @return the type for this index
+ */
Class<? extends TOP> type() default NoClassSet.class;
/**
* @see FsIndexDescription#getKind()
+ *
+ * @return the kind of index
*/
String kind() default KIND_BAG;
/**
* @see FsIndexDescription#getKeys()
+ *
+ * @return the keys for this index
*/
FsIndexKey[] keys() default {};
/**
* @see FsIndexKeyDescription#isTypePriority()
+ *
+ * @return true if and only if this is a type priority key
*/
boolean typePriorities() default true;
+ /**
+ * Indicates that no type has been set.
+ */
public static final class NoClassSet extends TOP { /* Nothing */
}
+ /**
+ * Indicated that no type name has been set.
+ */
public static final String NO_NAME_TYPE_SET = "org.apache.uima.fit.descriptor.FsIndex.NO_NAME_TYPE_SET";
}
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/FsIndexCollection.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/FsIndexCollection.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/FsIndexCollection.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/FsIndexCollection.java Tue Jan 21 00:39:16 2014
@@ -34,6 +34,8 @@ import org.apache.uima.fit.factory.FsInd
public @interface FsIndexCollection {
/**
* @see org.apache.uima.resource.metadata.FsIndexCollection#getFsIndexes()
+ *
+ * @return a description of the FS Indexes that comprise this FS Index Collection
*/
FsIndex[] fsIndexes();
}
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/FsIndexKey.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/FsIndexKey.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/FsIndexKey.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/FsIndexKey.java Tue Jan 21 00:39:16 2014
@@ -45,11 +45,15 @@ public @interface FsIndexKey {
/**
* @see FsIndexKeyDescription#getFeatureName()
+ *
+ * @return the name of this key's Feature
*/
String featureName();
/**
* @see FsIndexKeyDescription#getComparator()
+ *
+ * @return this key's comparator
*/
int comparator() default STANDARD_COMPARE;
}
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/OperationalProperties.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/OperationalProperties.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/OperationalProperties.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/OperationalProperties.java Tue Jan 21 00:39:16 2014
@@ -32,8 +32,7 @@ import java.lang.annotation.Target;
import org.apache.uima.analysis_engine.AnalysisEngine;
/**
- * Control aspects of the UIMA analysis component.<br/>
- *
+ * Control aspects of the UIMA analysis component.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/ResourceMetaData.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/ResourceMetaData.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/ResourceMetaData.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/ResourceMetaData.java Tue Jan 21 00:39:16 2014
@@ -36,6 +36,8 @@ public @interface ResourceMetaData {
* Gets the name of this Resource.
*
* @see org.apache.uima.resource.metadata.ResourceMetaData#getName()
+ *
+ * @return the name of this Resource
*/
String name() default "";
@@ -43,6 +45,8 @@ public @interface ResourceMetaData {
* Gets the copyright notice for this Resource.
*
* @see org.apache.uima.resource.metadata.ResourceMetaData#getCopyright()
+ *
+ * @return the copyright notice for this Resource
*/
String copyright() default "";
@@ -50,6 +54,8 @@ public @interface ResourceMetaData {
* Gets the description of this Resource.
*
* @see org.apache.uima.resource.metadata.ResourceMetaData#getDescription()
+ *
+ * @return the description of this Resource
*/
String description() default "";
@@ -57,6 +63,8 @@ public @interface ResourceMetaData {
* Gets the vendor of this Resource.
*
* @see org.apache.uima.resource.metadata.ResourceMetaData#getVendor()
+ *
+ * @return the vendor of this Resource, as a String
*/
String vendor() default "";
@@ -64,6 +72,8 @@ public @interface ResourceMetaData {
* Gets the version number of this Resource.
*
* @see org.apache.uima.resource.metadata.ResourceMetaData#getVersion()
+ *
+ * @return the version number of this Resource, as a String
*/
String version() default "";
}
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/SofaCapability.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/SofaCapability.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/SofaCapability.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/SofaCapability.java Tue Jan 21 00:39:16 2014
@@ -25,13 +25,13 @@ import java.lang.annotation.Target;
/**
*
- * <code><pre>
+ * <pre><code>
* {@literal @}SofaCapability(inputSofas = { GOLD_VIEW, SYSTEM_VIEW })
- * </pre></code>
+ * </code></pre>
* or
- * <code><pre>
+ * <pre><code>
* {@literal @}SofaCapability(inputSofas = CAS.NAME_DEFAULT_SOFA, outputSofas = GOLD_VIEW)
- * </pre></code>
+ * </code></pre>
*
* Adding this annotation to your analysis engine description makes your component "sofa aware." The
* base CAS delivered to "sofa aware" components has no explicit view associated with it. The logic
@@ -39,30 +39,35 @@ import java.lang.annotation.Target;
* as needed. You should therefore be aware that if you need to work with the "_InitialView" view,
* then you must explicitly request it with a call like:
*
- * <code><pre>
+ * <pre><code>
* JCas initialView = jCas.getView(CAS.NAME_DEFAULT_SOFA);
- * </pre></code>
+ * </code></pre>
*
* This is because the base CAS that it passed into the process method to "sofa aware" components is
* not the same as the "_InitialView". See how the following member variable is used to understand
* why/how:
*
- * org.apache.uima.analysis_engine.impl.PrimitiveAnalysisEngine_impl. mSofaAware
- *
+ * <pre><code>
+ * org.apache.uima.analysis_engine.impl.PrimitiveAnalysisEngine_impl.mSofaAware
+ * </code></pre>
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface SofaCapability {
/**
- * the values should be string vales corresponding to view names such as e.g.
+ * The values should be string vales corresponding to view names such as e.g.
* CAS.NAME_DEFAULT_SOFA that this analysis component expects to be present in the CAS.
+ *
+ * @return the input sofas
*/
String[] inputSofas() default NO_DEFAULT_VALUE;
/**
- * the values should be string vales corresponding to view names that this analysis component will
+ * The values should be string vales corresponding to view names that this analysis component will
* create.
+ *
+ * @return the output sofas
*/
String[] outputSofas() default NO_DEFAULT_VALUE;
@@ -70,7 +75,5 @@ public @interface SofaCapability {
* Provides the default value for the inputs and the outputs that tells the CapabilityFactory that
* no value has been given to the inputs or outputs elements.
*/
-
public static final String NO_DEFAULT_VALUE = "org.apache.uima.fit.descriptor.SofaCapability.NO_DEFAULT_VALUE";
-
}
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/TypeCapability.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/TypeCapability.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/TypeCapability.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/TypeCapability.java Tue Jan 21 00:39:16 2014
@@ -26,7 +26,7 @@ import java.lang.annotation.Target;
/**
* A typical use of this annotation might look something like:
*
- * <code><pre>
+ * <pre><code>
* {@literal @}TypeCapability(
* inputs="org.apache.uima.fit.type.Token",
* outputs="org.apache.uima.fit.type.Token:pos")
@@ -34,7 +34,7 @@ import java.lang.annotation.Target;
*
* or
*
- * <code><pre>
+ * <pre><code>
* {@literal @}TypeCapability(
* inputs={"org.apache.uima.fit.type.Token","org.apache.uima.fit.type.Sentence"},
* outputs={"org.apache.uima.fit.type.Token:pos", "org.apache.uima.tutorial.RoomNumber"})
@@ -51,6 +51,7 @@ public @interface TypeCapability {
* followed by a colon (':') followed by the feature name. A valid feature name from the uimaFIT
* test type system is "org.apache.uima.fit.type.Token:pos"
*
+ * @return the input types
*/
String[] inputs() default NO_DEFAULT_VALUE;
@@ -58,6 +59,8 @@ public @interface TypeCapability {
* outputs can be type names or feature names. A feature name typically looks like a type name
* followed by a colon (':') followed by the feature name. A valid feature name from the uimaFIT
* test type system is "org.apache.uima.fit.type.Token:pos"
+ *
+ * @return the output types
*/
String[] outputs() default NO_DEFAULT_VALUE;
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/AggregateBuilder.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/AggregateBuilder.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/AggregateBuilder.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/AggregateBuilder.java Tue Jan 21 00:39:16 2014
@@ -42,10 +42,7 @@ import org.apache.uima.resource.metadata
* This is an example taken from our test cases:
* </p>
*
- * <p>
- * <blockquote>
- *
- * <pre>
+ * <pre><code>
* import static org.apache.uima.fit.factory.AnalysisEngineFactory.createPrimitiveDescription;
*
* AggregateBuilder builder = new AggregateBuilder();
@@ -58,11 +55,7 @@ import org.apache.uima.resource.metadata
* builder.add(createPrimitiveDescription(Annotator3.class, typeSystemDescription),
* ViewNames.INITIAL_VIEW, "B");
* AnalysisEngine aggregateEngine = builder.createAggregate();
- * </pre>
- *
- * </blockquote>
- * </p>
- *
+ * </code></pre>
*/
public class AggregateBuilder {
@@ -110,6 +103,14 @@ public class AggregateBuilder {
* result of {@link AnalysisEngineDescription#getAnnotatorImplementationName()} for the component
* name
*
+ * @param aed
+ * an analysis engine description to add to the aggregate analysis engine
+ * @param viewNames
+ * pairs of view names corresponding to a componentSofaName followed by the
+ * aggregateSofaName that it is mapped to. An even number of names must be passed in or
+ * else an IllegalArgumentException will be thrown. See
+ * {@link SofaMappingFactory#createSofaMapping(String, String, String)}
+ *
* @return the name of the component generated for the {@link AnalysisEngineDescription}
*/
public String add(AnalysisEngineDescription aed, String... viewNames) {
@@ -199,6 +200,8 @@ public class AggregateBuilder {
* with the data collected by this builder.
*
* @return an aggregate analysis engine
+ * @throws ResourceInitializationException
+ * if there is a problem during initialization
*/
public AnalysisEngine createAggregate() throws ResourceInitializationException {
return AnalysisEngineFactory.createEngine(analysisEngineDescriptions, componentNames,
@@ -212,6 +215,8 @@ public class AggregateBuilder {
* with the data collected by this builder.
*
* @return a description of an aggregate analysis engine
+ * @throws ResourceInitializationException
+ * if there is a problem during initialization
*/
public AnalysisEngineDescription createAggregateDescription()
throws ResourceInitializationException {
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/AnnotationFactory.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/AnnotationFactory.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/AnnotationFactory.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/AnnotationFactory.java Tue Jan 21 00:39:16 2014
@@ -23,8 +23,7 @@ import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.tcas.Annotation;
/**
- *
- *
+ * Convenience methods to create annotations
*/
public final class AnnotationFactory {
private AnnotationFactory() {
@@ -33,6 +32,20 @@ public final class AnnotationFactory {
/**
* Provides a convenient way to create an annotation and addToIndexes in a single line.
+ *
+ * @param <T>
+ * the annotation type
+ * @param jCas
+ * the JCas to create the annotation in
+ * @param begin
+ * the begin offset
+ * @param end
+ * the end offset
+ * @param cls
+ * the annotation class as generated by JCasGen
+ * @return the new annotation
+ * @throws UIMAException
+ * if the annotation could not be created
*/
public static <T extends Annotation> T createAnnotation(JCas jCas, int begin, int end,
Class<T> cls) throws UIMAException {
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/CapabilityFactory.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/CapabilityFactory.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/CapabilityFactory.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/CapabilityFactory.java Tue Jan 21 00:39:16 2014
@@ -40,6 +40,9 @@ public final class CapabilityFactory {
/**
* Creates a single capability consisting of the information in the {@link SofaCapability} and
* {@link TypeCapability} annotations for the class.
+ *
+ * @param componentClass a class with capability annotations
+ * @return capabilities extracted from the class
*/
public static Capability createCapability(Class<?> componentClass) {
if (!ReflectionUtil.isAnnotationPresent(componentClass, SofaCapability.class)
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/CollectionReaderFactory.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/CollectionReaderFactory.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/CollectionReaderFactory.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/CollectionReaderFactory.java Tue Jan 21 00:39:16 2014
@@ -68,6 +68,10 @@ public final class CollectionReaderFacto
* Any additional configuration parameters to be set. These should be supplied as (name,
* value) pairs, so there should always be an even number of parameters.
* @return The CollectionReader created from the XML descriptor and the configuration parameters.
+ * @throws UIMAException
+ * if the descriptor could not be created or if the component could not be instantiated
+ * @throws IOException
+ * if the descriptor could not be read
*/
public static CollectionReader createReaderFromPath(String descriptorPath,
Object... configurationData) throws UIMAException, IOException {
@@ -86,6 +90,10 @@ public final class CollectionReaderFacto
* value) pairs, so there should always be an even number of parameters.
* @return The CollectionReader created from the XML descriptor and the configuration parameters.
* @deprecated use {@link #createReaderFromPath(String, Object...)}
+ * @throws UIMAException
+ * if the descriptor could not be created or if the component could not be instantiated
+ * @throws IOException
+ * if the descriptor could not be read
*/
@Deprecated
public static CollectionReader createCollectionReaderFromPath(String descriptorPath,
@@ -101,7 +109,11 @@ public final class CollectionReaderFacto
* @param configurationData
* Any additional configuration parameters to be set. These should be supplied as (name,
* value) pairs, so there should always be an even number of parameters.
- * @return The CollectionReader created from the XML descriptor and the configuration parameters.
+ * @return the description created from the XML descriptor and the configuration parameters.
+ * @throws UIMAException
+ * if the descriptor could not be created or if the component could not be instantiated
+ * @throws IOException
+ * if the descriptor could not be read
*/
public static CollectionReaderDescription createReaderDescriptionFromPath(String descriptorPath,
Object... configurationData) throws UIMAException, IOException {
@@ -120,6 +132,10 @@ public final class CollectionReaderFacto
* value) pairs, so there should always be an even number of parameters.
* @return The CollectionReader created from the XML descriptor and the configuration parameters.
* @deprecated use {@link #createReaderDescriptionFromPath(String, Object...)}
+ * @throws UIMAException
+ * if the descriptor could not be created or if the component could not be instantiated
+ * @throws IOException
+ * if the descriptor could not be read
*/
@Deprecated
public static CollectionReaderDescription createCollectionReaderDescriptionFromPath(
@@ -137,6 +153,10 @@ public final class CollectionReaderFacto
* Any additional configuration parameters to be set. These should be supplied as (name,
* value) pairs, so there should always be an even number of parameters.
* @return The AnalysisEngine created from the XML descriptor and the configuration parameters.
+ * @throws UIMAException
+ * if the descriptor could not be created or if the component could not be instantiated
+ * @throws IOException
+ * if the descriptor could not be read
*/
public static CollectionReader createReader(String descriptorName,
Object... configurationData) throws UIMAException, IOException {
@@ -158,6 +178,10 @@ public final class CollectionReaderFacto
* value) pairs, so there should always be an even number of parameters.
* @return The AnalysisEngine created from the XML descriptor and the configuration parameters.
* @deprecated use {@link #createReader(String, Object...)}
+ * @throws UIMAException
+ * if the descriptor could not be created or if the component could not be instantiated
+ * @throws IOException
+ * if the descriptor could not be read
*/
@Deprecated
public static CollectionReader createCollectionReader(String descriptorName,
@@ -177,6 +201,8 @@ public final class CollectionReaderFacto
* value) pairs, so there should always be an even number of parameters.
* @return The CollectionReader created and initialized with the type system and configuration
* parameters.
+ * @throws ResourceInitializationException
+ * if the component could not be initialized
*/
public static CollectionReader createReader(
Class<? extends CollectionReader> readerClass, Object... configurationData)
@@ -198,6 +224,8 @@ public final class CollectionReaderFacto
* @return The CollectionReader created and initialized with the type system and configuration
* parameters.
* @deprecated use {@link #createReader(Class, Object...)}
+ * @throws ResourceInitializationException
+ * if the component could not be initialized
*/
@Deprecated
public static CollectionReader createCollectionReader(
@@ -219,6 +247,8 @@ public final class CollectionReaderFacto
* value) pairs, so there should always be an even number of parameters.
* @return The CollectionReader created and initialized with the type system and configuration
* parameters.
+ * @throws ResourceInitializationException
+ * if the component could not be initialized
*/
public static CollectionReader createReader(
Class<? extends CollectionReader> readerClass, TypeSystemDescription typeSystem,
@@ -240,6 +270,8 @@ public final class CollectionReaderFacto
* @return The CollectionReader created and initialized with the type system and configuration
* parameters.
* @deprecated use {@link #createReader(Class, TypeSystemDescription, Object...)}
+ * @throws ResourceInitializationException
+ * if the component could not be initialized
*/
@Deprecated
public static CollectionReader createCollectionReader(
@@ -248,6 +280,26 @@ public final class CollectionReaderFacto
return createReader(readerClass, typeSystem, configurationData);
}
+ /**
+ * Get a CollectionReader from a CollectionReader class, a type system, and a set of configuration
+ * parameters.
+ *
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param typeSystem
+ * A description of the types used by the CollectionReader (may be null).
+ * @param prioritizedTypeNames
+ * the type names in order of their priority.
+ * @param configurationData
+ * Any additional configuration parameters to be set. These should be supplied as (name,
+ * value) pairs, so there should always be an even number of parameters.
+ * @return The CollectionReader created and initialized with the type system and configuration
+ * parameters.
+ * @deprecated use {@link #createReaderDescription(Class, TypeSystemDescription, String[], Object...)}
+ * @throws ResourceInitializationException
+ * if the component could not be initialized
+ */
+ @Deprecated
public static CollectionReader createReader(
Class<? extends CollectionReader> readerClass, TypeSystemDescription typeSystem,
String[] prioritizedTypeNames, Object... configurationData)
@@ -257,6 +309,24 @@ public final class CollectionReaderFacto
}
/**
+ * Get a CollectionReader from a CollectionReader class, a type system, and a set of configuration
+ * parameters.
+ *
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param typeSystem
+ * A description of the types used by the CollectionReader (may be null).
+ * @param prioritizedTypeNames
+ * the type names in order of their priority.
+ * @param configurationData
+ * Any additional configuration parameters to be set. These should be supplied as (name,
+ * value) pairs, so there should always be an even number of parameters.
+ * @return The CollectionReader created and initialized with the type system and configuration
+ * parameters.
+ * @deprecated use {@link #createReaderDescription(Class, TypeSystemDescription, String[], Object...)}
+ * @throws ResourceInitializationException
+ * if the component could not be initialized
+ *
* @deprecated use {@link #createReader(Class, TypeSystemDescription, String[], Object...)}
*/
@Deprecated
@@ -267,6 +337,22 @@ public final class CollectionReaderFacto
return createReader(readerClass, typeSystem, prioritizedTypeNames, configurationData);
}
+ /**
+ *
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param typeSystem
+ * A description of the types used by the CollectionReader (may be null).
+ * @param typePriorities
+ * the type priorities
+ * @param configurationData
+ * configuration parameter data as name value pairs. Will override values already set in
+ * the description.
+ * @return The CollectionReader created and initialized with the type system and configuration
+ * parameters.
+ * @throws ResourceInitializationException
+ * if the component could not be initialized
+ */
public static CollectionReader createReader(
Class<? extends CollectionReader> readerClass, TypeSystemDescription typeSystem,
TypePriorities typePriorities, Object... configurationData)
@@ -277,6 +363,20 @@ public final class CollectionReaderFacto
}
/**
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param typeSystem
+ * A description of the types used by the CollectionReader (may be null).
+ * @param typePriorities
+ * the type priorities
+ * @param configurationData
+ * configuration parameter data as name value pairs. Will override values already set in
+ * the description.
+ * @return The CollectionReader created and initialized with the type system and configuration
+ * parameters.
+ * @throws ResourceInitializationException
+ * if the component could not be initialized
+ *
* @deprecated use {@link #createReader(Class, TypeSystemDescription, TypePriorities, Object...)}
*/
@Deprecated
@@ -291,9 +391,15 @@ public final class CollectionReaderFacto
* This method creates a CollectionReader from a CollectionReaderDescription adding additional
* configuration parameter data as desired
*
+ * @param desc
+ * a descriptor
* @param configurationData
* configuration parameter data as name value pairs. Will override values already set in
* the description.
+ * @return The CollectionReader created and initialized with the type system and configuration
+ * parameters.
+ * @throws ResourceInitializationException
+ * if the component could not be initialized
*/
public static CollectionReader createReader(CollectionReaderDescription desc,
Object... configurationData) throws ResourceInitializationException {
@@ -306,9 +412,16 @@ public final class CollectionReaderFacto
* This method creates a CollectionReader from a CollectionReaderDescription adding additional
* configuration parameter data as desired
*
+ * @param desc
+ * a descriptor
* @param configurationData
* configuration parameter data as name value pairs. Will override values already set in
* the description.
+ * @return The CollectionReader created and initialized with the type system and configuration
+ * parameters.
+ * @throws ResourceInitializationException
+ * if the component could not be initialized
+ *
* @deprecated use {@link #createReader(CollectionReaderDescription, Object...)}
*/
@Deprecated
@@ -321,6 +434,16 @@ public final class CollectionReaderFacto
* A simple factory method for creating a CollectionReaderDescription with a given class, type
* system description, and configuration data The type system is detected automatically using
* {@link TypeSystemDescriptionFactory#createTypeSystemDescription()}.
+ *
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param configurationData
+ * configuration parameter data as name value pairs. Will override values already set in
+ * the description.
+ * @throws ResourceInitializationException
+ * if the descriptor could not be set up
+ * @return the description created from the default parameters specified in the class and the
+ * configuration parameters
*/
public static CollectionReaderDescription createReaderDescription(
Class<? extends CollectionReader> readerClass, Object... configurationData)
@@ -334,6 +457,16 @@ public final class CollectionReaderFacto
* system description, and configuration data The type system is detected automatically using
* {@link TypeSystemDescriptionFactory#createTypeSystemDescription()}.
*
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param configurationData
+ * configuration parameter data as name value pairs. Will override values already set in
+ * the description.
+ * @return the description created from the default parameters specified in the class and the
+ * configuration parameters
+ * @throws ResourceInitializationException
+ * if the descriptor could not be set up
+ *
* @deprecated use {@link #createReaderDescription(Class, Object...)}
*/
@Deprecated
@@ -347,6 +480,18 @@ public final class CollectionReaderFacto
/**
* A simple factory method for creating a CollectionReaderDescription with a given class, type
* system description, and configuration data
+ *
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param typeSystem
+ * A description of the types used by the CollectionReader (may be null).
+ * @param configurationData
+ * configuration parameter data as name value pairs. Will override values already set in
+ * the description.
+ * @return the description created from the default parameters specified in the class and the
+ * configuration parameters
+ * @throws ResourceInitializationException
+ * if the descriptor could not be set up
*/
public static CollectionReaderDescription createReaderDescription(
Class<? extends CollectionReader> readerClass, TypeSystemDescription typeSystem,
@@ -358,6 +503,18 @@ public final class CollectionReaderFacto
* A simple factory method for creating a CollectionReaderDescription with a given class, type
* system description, and configuration data
*
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param typeSystem
+ * A description of the types used by the CollectionReader (may be null).
+ * @param configurationData
+ * configuration parameter data as name value pairs. Will override values already set in
+ * the description.
+ * @return the description created from the default parameters specified in the class and the
+ * configuration parameters
+ * @throws ResourceInitializationException
+ * if the descriptor could not be set up
+ *
* @deprecated use {@link #createReaderDescription(Class, TypeSystemDescription, Object...)}
*/
@Deprecated
@@ -367,6 +524,21 @@ public final class CollectionReaderFacto
return createReaderDescription(readerClass, typeSystem, configurationData);
}
+ /**
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param typeSystem
+ * A description of the types used by the CollectionReader (may be null).
+ * @param prioritizedTypeNames
+ * the type names in order of their priority.
+ * @param configurationData
+ * configuration parameter data as name value pairs. Will override values already set in
+ * the description.
+ * @return the description created from the default parameters specified in the class and the
+ * configuration parameters
+ * @throws ResourceInitializationException
+ * if the descriptor could not be set up
+ */
public static CollectionReaderDescription createReaderDescription(
Class<? extends CollectionReader> readerClass, TypeSystemDescription typeSystem,
String[] prioritizedTypeNames, Object... configurationData)
@@ -376,6 +548,20 @@ public final class CollectionReaderFacto
}
/**
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param typeSystem
+ * A description of the types used by the CollectionReader (may be null).
+ * @param prioritizedTypeNames
+ * the type names in order of their priority.
+ * @param configurationData
+ * configuration parameter data as name value pairs. Will override values already set in
+ * the description.
+ * @return the description created from the default parameters specified in the class and the
+ * configuration parameters
+ * @throws ResourceInitializationException
+ * if the descriptor could not be set up
+ *
* @deprecated use {@link #createReaderDescription(Class, TypeSystemDescription, String[], Object...)}
*/
@Deprecated
@@ -386,6 +572,22 @@ public final class CollectionReaderFacto
return createReaderDescription(readerClass, typeSystem, prioritizedTypeNames, configurationData);
}
+ /**
+ *
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param typeSystem
+ * A description of the types used by the CollectionReader (may be null).
+ * @param typePriorities
+ * the type priorities
+ * @param configurationData
+ * configuration parameter data as name value pairs. Will override values already set in
+ * the description.
+ * @return the description created from the default parameters specified in the class and the
+ * configuration parameters
+ * @throws ResourceInitializationException
+ * if the descriptor could not be set up
+ */
public static CollectionReaderDescription createReaderDescription(
Class<? extends CollectionReader> readerClass, TypeSystemDescription typeSystem,
TypePriorities typePriorities, Object... configurationData)
@@ -395,6 +597,20 @@ public final class CollectionReaderFacto
}
/**
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param typeSystem
+ * A description of the types used by the CollectionReader (may be null).
+ * @param typePriorities
+ * the type priorities
+ * @param configurationData
+ * configuration parameter data as name value pairs. Will override values already set in
+ * the description.
+ * @return the description created from the default parameters specified in the class and the
+ * configuration parameters
+ * @throws ResourceInitializationException
+ * if the descriptor could not be set up
+ *
* @deprecated use {@link #createReaderDescription(Class, TypeSystemDescription, TypePriorities, Object...)}
*/
@Deprecated
@@ -405,6 +621,26 @@ public final class CollectionReaderFacto
return createReaderDescription(readerClass, typeSystem, typePriorities, configurationData);
}
+ /**
+ *
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param typeSystem
+ * A description of the types used by the CollectionReader (may be null).
+ * @param typePriorities
+ * the type priorities
+ * @param indexes
+ * the index definitions
+ * @param capabilities
+ * the input and output capabilities
+ * @param configurationData
+ * configuration parameter data as name value pairs. Will override values already set in
+ * the description.
+ * @return the description created from the default parameters specified in the class and the
+ * configuration parameters
+ * @throws ResourceInitializationException
+ * if the descriptor could not be set up
+ */
public static CollectionReaderDescription createReaderDescription(
Class<? extends CollectionReader> readerClass, TypeSystemDescription typeSystem,
TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities,
@@ -424,6 +660,24 @@ public final class CollectionReaderFacto
}
/**
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param typeSystem
+ * A description of the types used by the CollectionReader (may be null).
+ * @param typePriorities
+ * the type priorities
+ * @param indexes
+ * the index definitions
+ * @param capabilities
+ * the input and output capabilities
+ * @param configurationData
+ * configuration parameter data as name value pairs. Will override values already set in
+ * the description.
+ * @return the description created from the default parameters specified in the class and the
+ * configuration parameters
+ * @throws ResourceInitializationException
+ * if the descriptor could not be set up
+ *
* @deprecated use {@link #createReaderDescription(Class, TypeSystemDescription, TypePriorities, FsIndexCollection, Capability[], Object...)}
*/
@Deprecated
@@ -435,6 +689,27 @@ public final class CollectionReaderFacto
configurationData);
}
+ /**
+ *
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param typeSystem
+ * A description of the types used by the CollectionReader (may be null).
+ * @param typePriorities
+ * the type priorities
+ * @param indexes
+ * the index definitions
+ * @param capabilities
+ * the input and output capabilities
+ * @param configurationParameters
+ * the configuration parameters
+ * @param configurationValues
+ * the configuration values associated with the parameters
+ * @return the description created from the default parameters specified in the class and the
+ * configuration parameters
+ * @throws ResourceInitializationException
+ * if the descriptor could not be set up
+ */
public static CollectionReaderDescription createReaderDescription(
Class<? extends CollectionReader> readerClass, TypeSystemDescription typeSystem,
TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities,
@@ -445,6 +720,24 @@ public final class CollectionReaderFacto
}
/**
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param typeSystem
+ * A description of the types used by the CollectionReader (may be null).
+ * @param typePriorities
+ * the type priorities
+ * @param indexes
+ * the index definitions
+ * @param capabilities
+ * the input and output capabilities
+ * @param configurationParameters
+ * the configuration parameters
+ * @param configurationValues
+ * the configuration values associated with the parameters
+ * @return the description created from the default parameters specified in the class and the
+ * configuration parameters
+ * @throws ResourceInitializationException
+ * if the descriptor could not be set up
* @deprecated use {@link #createReaderDescription(Class, TypeSystemDescription, TypePriorities, FsIndexCollection, Capability[], ConfigurationParameter[], Object[])}
*/
@Deprecated
@@ -460,6 +753,27 @@ public final class CollectionReaderFacto
/**
* The factory method for creating CollectionReaderDescription objects for a given class,
* TypeSystemDescription, TypePriorities, capabilities, and configuration data
+ *
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param typeSystem
+ * A description of the types used by the CollectionReader (may be null).
+ * @param typePriorities
+ * the type priorities
+ * @param indexes
+ * the index definitions
+ * @param capabilities
+ * the input and output capabilities
+ * @param configurationParameters
+ * the configuration parameters
+ * @param configurationValues
+ * the configuration values associated with the parameters
+ * @param externalResources
+ * the external resources
+ * @return the description created from the default parameters specified in the class and the
+ * configuration parameters
+ * @throws ResourceInitializationException
+ * if the descriptor could not be set up
*/
public static CollectionReaderDescription createReaderDescription(
Class<? extends CollectionReader> readerClass, TypeSystemDescription typeSystem,
@@ -525,7 +839,29 @@ public final class CollectionReaderFacto
* The factory method for creating CollectionReaderDescription objects for a given class,
* TypeSystemDescription, TypePriorities, capabilities, and configuration data
*
- * @deprecated use {@link #createReaderDescription(Class, TypeSystemDescription, TypePriorities, FsIndexCollection, Capability[], ConfigurationParameter[], Object[], Map)}
+ * @param readerClass
+ * The class of the CollectionReader to be created.
+ * @param typeSystem
+ * A description of the types used by the CollectionReader (may be null).
+ * @param typePriorities
+ * the type priorities
+ * @param indexes
+ * the index definitions
+ * @param capabilities
+ * the input and output capabilities
+ * @param configurationParameters
+ * the configuration parameters
+ * @param configurationValues
+ * the configuration values associated with the parameters
+ * @param externalResources
+ * the external resources
+ * @return the description created from the default parameters specified in the class and the
+ * configuration parameters
+ * @throws ResourceInitializationException
+ * if the descriptor could not be set up
+ *
+ * @deprecated use
+ * {@link #createReaderDescription(Class, TypeSystemDescription, TypePriorities, FsIndexCollection, Capability[], ConfigurationParameter[], Object[], Map)}
*/
@Deprecated
public static CollectionReaderDescription createDescription(
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/ConfigurationParameterFactory.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/ConfigurationParameterFactory.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/ConfigurationParameterFactory.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/ConfigurationParameterFactory.java Tue Jan 21 00:39:16 2014
@@ -74,6 +74,10 @@ public final class ConfigurationParamete
/**
* This method determines if the field is annotated with
* {@link org.apache.uima.fit.descriptor.ConfigurationParameter}.
+ *
+ * @param field
+ * the field to analyze
+ * @return whether the field is marked as a configuration parameter
*/
public static boolean isConfigurationParameterField(Field field) {
return ReflectionUtil.isAnnotationPresent(field,
@@ -85,6 +89,10 @@ public final class ConfigurationParamete
* necessarily the value that the annotated member variable will be instantiated with in
* ConfigurationParameterInitializer which does extra work to convert the UIMA configuration
* parameter value to comply with the type of the member variable.
+ *
+ * @param field
+ * the field to analyze
+ * @return the default value
*/
public static Object getDefaultValue(Field field) {
if (isConfigurationParameterField(field)) {
@@ -179,6 +187,10 @@ public final class ConfigurationParamete
/**
* This method generates the default name of a configuration parameter that is defined by an
* {@link org.apache.uima.fit.descriptor.ConfigurationParameter} annotation when no name is given
+ *
+ * @param field
+ * the field to analyze
+ * @return the parameter name
*/
public static String getConfigurationParameterName(Field field) {
if (isConfigurationParameterField(field)) {
@@ -195,6 +207,10 @@ public final class ConfigurationParamete
/**
* A factory method for creating a ConfigurationParameter from a given field definition
+ *
+ * @param field
+ * the field to analyze
+ * @return the configuration parameter.
*/
public static ConfigurationParameter createPrimitiveParameter(Field field) {
if (isConfigurationParameterField(field)) {
@@ -213,6 +229,16 @@ public final class ConfigurationParamete
/**
* A factory method for creating a ConfigurationParameter object.
+ *
+ * @param name
+ * the parameter name
+ * @param parameterClass
+ * the parameter class
+ * @param parameterDescription
+ * the parameter description
+ * @param isMandatory
+ * whether the parameter is mandatory
+ * @return the configuration parameter
*/
public static ConfigurationParameter createPrimitiveParameter(String name,
Class<?> parameterClass, String parameterDescription, boolean isMandatory) {
@@ -276,6 +302,18 @@ public final class ConfigurationParamete
/**
* A factory method for creating a ConfigurationParameter object.
+ *
+ * @param name
+ * the parameter name
+ * @param parameterType
+ * the parameter type
+ * @param parameterDescription
+ * the parameter description
+ * @param isMultiValued
+ * whether the parameter is multi-valued
+ * @param isMandatory
+ * whether the parameter is mandatory
+ * @return the configuration parameter
*/
public static ConfigurationParameter createPrimitiveParameter(String name, String parameterType,
String parameterDescription, boolean isMultiValued, boolean isMandatory) {
@@ -322,6 +360,11 @@ public final class ConfigurationParamete
* {@link ConfigurationData} object. This should only be used to prepare values supplied in a
* factory method call for merging with existing parameter declarations, e.g. extracted from a
* class using {@link #createConfigurationData(Class)}.
+ *
+ * @param configurationData
+ * configuration parameters as (name, value) pairs, so there should always be an even
+ * number of parameters.
+ * @return the configuration data
*/
public static ConfigurationData createConfigurationData(Object... configurationData) {
if (configurationData == null) {
@@ -356,6 +399,10 @@ public final class ConfigurationParamete
/**
* This method creates configuration data for a given class definition using reflection and the
* configuration parameter annotation
+ *
+ * @param componentClass
+ * the class to analyze
+ * @return the configuration settings extracted from the class
*/
public static ConfigurationData createConfigurationData(Class<?> componentClass) {
List<ConfigurationParameter> configurationParameters = new ArrayList<ConfigurationParameter>();
@@ -376,13 +423,18 @@ public final class ConfigurationParamete
/**
* A simple class for storing an array of configuration parameters along with an array of the
* values that will fill in those configuration parameters
- *
*/
public static class ConfigurationData {
public ConfigurationParameter[] configurationParameters;
public Object[] configurationValues;
+ /**
+ * @param configurationParameters
+ * the configuration parameters
+ * @param configurationValues
+ * the configuration parameter values
+ */
public ConfigurationData(ConfigurationParameter[] configurationParameters,
Object[] configurationValues) {
this.configurationParameters = configurationParameters;
@@ -395,6 +447,8 @@ public final class ConfigurationParamete
* This method adds configuration parameter information to the specifier given the provided
* configuration data
*
+ * @param specifier
+ * the specified to add the parameters to
* @param configurationData
* should consist of name value pairs.
*/
@@ -410,6 +464,11 @@ public final class ConfigurationParamete
* Provides a mechanism to add configuration parameter information to a specifier for the given
* classes. This method may be useful in situations where a class definition has annotated
* configuration parameters that you want to include in the given specifier.
+ *
+ * @param specifier
+ * the specified to add the parameters to
+ * @param dynamicallyLoadedClasses
+ * the classes to analyze and extract parameter information from
*/
public static void addConfigurationParameters(ResourceCreationSpecifier specifier,
List<Class<?>> dynamicallyLoadedClasses) {
@@ -426,6 +485,11 @@ public final class ConfigurationParamete
* Provides a mechanism to add configuration parameter information to a specifier for the given
* classes. This method may be useful in situations where a class definition has annotated
* configuration parameters that you want to include in the given specifier
+ *
+ * @param specifier
+ * the specified to add the parameters to
+ * @param dynamicallyLoadedClasses
+ * the classes to analyze and extract parameter information from
*/
public static void addConfigurationParameters(ResourceCreationSpecifier specifier,
Class<?>... dynamicallyLoadedClasses) {
@@ -440,6 +504,13 @@ public final class ConfigurationParamete
/**
* Adds a single configuration parameter name value pair to a specifier
+ *
+ * @param specifier
+ * the specifier to add the parameter setting to
+ * @param name
+ * the name of the parameter
+ * @param value
+ * the parameter value
*/
public static void addConfigurationParameter(ResourceCreationSpecifier specifier, String name,
Object value) {
@@ -556,6 +627,12 @@ public final class ConfigurationParamete
/**
* Check if the given parameter can be set on the provided specifier. Some specifier types require
* parameters to be declared before they can be set.
+ *
+ * @param aSpec
+ * the specifier to test
+ * @param name
+ * the parameter to be tested
+ * @return if the parameter can be set
*/
public static boolean canParameterBeSet(ResourceSpecifier aSpec, String name) {
if (aSpec instanceof CustomResourceSpecifier) {
Modified: uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/ExternalResourceFactory.java
URL: http://svn.apache.org/viewvc/uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/ExternalResourceFactory.java?rev=1559866&r1=1559865&r2=1559866&view=diff
==============================================================================
--- uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/ExternalResourceFactory.java (original)
+++ uima/uimafit/branches/2.0.x/uimafit-core/src/main/java/org/apache/uima/fit/factory/ExternalResourceFactory.java Tue Jan 21 00:39:16 2014
@@ -96,6 +96,10 @@ public final class ExternalResourceFacto
/**
* This method determines if the field is annotated with
* {@link org.apache.uima.fit.descriptor.ExternalResource}.
+ *
+ * @param field
+ * the field to analyze
+ * @return whether the field is marked as an external resource
*/
public static boolean isExternalResourceField(Field field) {
return ReflectionUtil.isAnnotationPresent(field,
@@ -346,6 +350,10 @@ public final class ExternalResourceFacto
/**
* Creates an ExternalResourceDependency for a field annotated with
* {@link org.apache.uima.fit.descriptor.ExternalResource}.
+ *
+ * @param field
+ * the field to analyze
+ * @return a external resource dependency
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
public static ExternalResourceDependency createExternalResourceDependency(Field field) {
@@ -382,8 +390,15 @@ public final class ExternalResourceFacto
/**
* Creates an ExternalResourceDependency for a given key and interface
*
+ * @param aKey
+ * the resource key
+ * @param aInterface
+ * the resource interface
* @param aOptional
* determines whether the dependency is optional
+ * @param aDescription
+ * a description of the resource
+ * @return the external resource dependency
*/
public static ExternalResourceDependency createExternalResourceDependency(final String aKey,
final Class<?> aInterface, final boolean aOptional, String aDescription) {
@@ -395,6 +410,13 @@ public final class ExternalResourceFacto
return dep;
}
+ /**
+ * @param cls
+ * the class to analyze
+ * @return the external resource dependencies
+ * @throws ResourceInitializationException
+ * if the external resource dependencies could not be created
+ */
public static ExternalResourceDependency[] createExternalResourceDependencies(
Class<?> cls) throws ResourceInitializationException {
Map<String, ExternalResourceDependency> depMap = new HashMap<String, ExternalResourceDependency>();
@@ -443,6 +465,8 @@ public final class ExternalResourceFacto
* the key to bind to.
* @param aUrl
* a URL.
+ * @throws InvalidXMLException
+ * if import resolution failed
* @see FileResourceSpecifier
*/
public static void bindResource(ResourceSpecifier aDesc, String aKey, URL aUrl)
@@ -467,6 +491,8 @@ public final class ExternalResourceFacto
* the key to bind to.
* @param aFile
* a file.
+ * @throws InvalidXMLException
+ * if import resolution failed
* @see FileResourceSpecifier
*/
public static void bindResource(ResourceSpecifier aDesc, String aKey, File aFile)
@@ -497,6 +523,8 @@ public final class ExternalResourceFacto
* the key to bind to.
* @param aUrl
* a URL.
+ * @throws InvalidXMLException
+ * if import resolution failed
* @see FileResourceSpecifier
*/
public static void bindResource(ResourceSpecifier aDesc, String aKey, String aUrl)
@@ -515,6 +543,10 @@ public final class ExternalResourceFacto
* the resource to bind.
* @param aParams
* parameters passed to the resource when it is created.
+ * @throws InvalidXMLException
+ * if import resolution failed
+ * @throws ClassNotFoundException
+ * if the resource implementation class or interface class could not be accessed
* @see CustomResourceSpecifier
*/
public static void bindResource(ResourceSpecifier aDesc, Class<? extends Resource> aRes,
@@ -534,6 +566,10 @@ public final class ExternalResourceFacto
* the resource to bind.
* @param aParams
* parameters passed to the resource when it is created.
+ * @throws InvalidXMLException
+ * if import resolution failed
+ * @throws ClassNotFoundException
+ * if the resource implementation class or interface class could not be accessed
* @see CustomResourceSpecifier
*/
public static void bindResource(ResourceSpecifier aDesc, Class<?> aApi,
@@ -558,6 +594,10 @@ public final class ExternalResourceFacto
* the URL from which the resource is initialized.
* @param aParams
* parameters passed to the resource when it is created.
+ * @throws InvalidXMLException
+ * if import resolution failed
+ * @throws ClassNotFoundException
+ * if the resource implementation class or interface class could not be accessed
* @see SharedResourceObject
*/
public static void bindResource(ResourceSpecifier aDesc,
@@ -582,6 +622,8 @@ public final class ExternalResourceFacto
* the URL from which the resource is initialized.
* @param aParams
* parameters passed to the resource when it is created.
+ * @throws InvalidXMLException
+ * if import resolution failed
* @see SharedResourceObject
*/
public static void bindResource(ResourceSpecifier aDesc, Class<?> aApi,
@@ -604,6 +646,8 @@ public final class ExternalResourceFacto
* the URL from which the resource is initialized.
* @param aParams
* parameters passed to the resource when it is created.
+ * @throws InvalidXMLException
+ * if import resolution failed
* @see SharedResourceObject
*/
public static void bindResource(ResourceSpecifier aDesc, String aKey,
@@ -626,6 +670,8 @@ public final class ExternalResourceFacto
* the resource to bind.
* @param aParams
* parameters passed to the resource when it is created.
+ * @throws InvalidXMLException
+ * if import resolution failed
* @see CustomResourceSpecifier
*/
public static void bindResource(ResourceSpecifier aDesc, String aKey,
@@ -649,6 +695,10 @@ public final class ExternalResourceFacto
* a description.
* @param aResDesc
* the resource description.
+ * @throws InvalidXMLException
+ * if import resolution failed
+ * @throws ClassNotFoundException
+ * if the resource implementation class or interface class could not be accessed
*/
public static void bindResource(ResourceSpecifier aDesc, ExternalResourceDescription aResDesc)
throws InvalidXMLException, ClassNotFoundException {
@@ -668,6 +718,8 @@ public final class ExternalResourceFacto
* the key to bind to.
* @param aResDesc
* the resource description.
+ * @throws InvalidXMLException
+ * if import resolution failed
*/
public static void bindResource(ResourceSpecifier aDesc, String aKey,
ExternalResourceDescription aResDesc) throws InvalidXMLException {
@@ -690,6 +742,8 @@ public final class ExternalResourceFacto
* the resource implementation.
* @param aParams
* additional parameters supported by the resource.
+ * @throws InvalidXMLException
+ * if import resolution failed
*/
public static void createDependencyAndBind(ResourceSpecifier aDesc, String aKey,
Class<? extends Resource> aImpl, String... aParams) throws InvalidXMLException {
@@ -709,8 +763,12 @@ public final class ExternalResourceFacto
* the key to bind to.
* @param aImpl
* the resource implementation.
+ * @param aApi
+ * the resource interface
* @param aParams
* additional parameters supported by the resource.
+ * @throws InvalidXMLException
+ * if import resolution failed
*/
public static void createDependencyAndBind(ResourceSpecifier aDesc, String aKey,
Class<? extends Resource> aImpl, Class<?> aApi, String... aParams)
@@ -808,6 +866,8 @@ public final class ExternalResourceFacto
* the resource URL.
* @param aParams
* additional parameters supported by the resource.
+ * @throws InvalidXMLException
+ * if import resolution failed
*/
public static void createDependencyAndBind(AnalysisEngineDescription aDesc, String aKey,
Class<? extends SharedResourceObject> aImpl, String aUrl, Object... aParams)