|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
File object is accepted by this filter.
File object is accepted by this filter.
CasProcessorDeploymentParam param
CasProcessorExecArg instance to the list.
ProcessTrace.
CASAdminException object.
XCASParsingException object.
ResultSpecification.
ResultSpecification.
CasConsumer to this CPM.
CasProcessor to this CPM's list of consumers.
CasProcessor to this CPM's list of consumers.
CpeCasProcessor to the end of
the list containing CPE CasProcessors.
CpeCasProcessor at a specified
location in the list of CPE CasProcessors.
CasProcessorExecArg argument to be supplied
when launching a program.
StdChannelListener interface, to the list
of standard message channel listeners.
ProcessTrace.
ProcessTrace.
StringBuffer object.
SimpleResourceFactory by adding a new mapping between a
ResourceSpecifier class and a Resource class.
SimpleResourceFactory by adding a new mapping between a
ResourceSpecifier class and a Resource class.
MessageRouter.StdChannelListener interface
to the list of standard channel listeners.
TypePriorityList.
TypePriorityList and adds it to this object.
Properties object.
ResultSpecification for the language x-unspecified.
ResultSpecification for the specified languages.
ResultSpecification for the language x-unspecified.
ResultSpecification for the specified languages.
ResultSpecification for the language
x-unspecified.
ResultSpecification for the specified
languages.
StdStreamListener interface to the list
of standard stream listeners.
ProcessTrace with this one.
AnalysisEngineDescription contains all of the information needed to instantiate
and use an AnalysisEngine.ProcessTrace object.AnalysisEngineProcessException may be thrown by an Analysis Engine's process
method, indicating that a failure occurred during processing.UIMAException.STANDARD_MESSAGE_CATALOG.
UIMAException.STANDARD_MESSAGE_CATALOG.
uima.tcas.Annotation.AnnotatorConfigurationException is thrown by an annotator if the settings of
its configuration parameters are invalid.UIMAException.STANDARD_MESSAGE_CATALOG.
UIMAException.STANDARD_MESSAGE_CATALOG.
AnnotatorContextException is thrown by an AnnotatorContext if it cannot
complete the invoked operation due to a failure in the underlying implementation.UIMAException.STANDARD_MESSAGE_CATALOG.
UIMAException.STANDARD_MESSAGE_CATALOG.
AnnotatorInitializationException may be thrown by an annotator's initialize
method, indicating that the annotator failed to successfully initialize itself.UIMAException.STANDARD_MESSAGE_CATALOG.
UIMAException.STANDARD_MESSAGE_CATALOG.
AnnotatorProcessException may be thrown by an annotator's process method,
indicating that a failure occurred during processing.UIMAException.STANDARD_MESSAGE_CATALOG.
UIMAException.STANDARD_MESSAGE_CATALOG.
ASB) is the component responsible for the details
of communicating with Analysis Engines that may potentially be distributed across different
physical machines.Style to further define its
behavior.CollectionReader interface.BaseCPM as various events
occur.CLASSPATH for the installed component, including CLASSPATH
for all separate delegate components that are utilized by the main installed component, if any.
lib directory.
lib directory.
PATH for the installed component, including PATH for all
separate delegate components that are utilized by the main installed component, if any.
PackageBrowser.buildComponentClassPath(), but without all jars from the lib dir.
Properties table that contains (name, value) pairs of environment
variables settings for a given installation descriptor object.
Properties table of required environment variables for the installed
component, including environment variables for all separate delegate components that are
utilized by the main installed component, if any.
Capability defines an operation that an Resource can carry out.CapabilityLanguageFlow is a simple type of FlowConstraints that
specifies the complete flow as a capabilityLanguage sequence.UIMAFramework.getDefaultPerformanceTuningProperties().
CASAdminException
CAS interface.CasConsumerDescription contains all of the information needed to instantiate
and use an CasConsumer.CasDataCollectionReader is used to iterate over the elements of a Collection.CasData
interface to access the CAS.CasData interface
to access the CAS.XmlDetagger for an example.XmlDetagger for an example.CasData.CollectionProcessingManager as various events occur.CAS interface.XmlDetagger for an example.XmlDetagger for an example.XmlDetagger for an example.CAS interface.CAS implementation.CAS instances.CasPool.CasProcessorDeploymentParam instances.CasProcessorExecArg
instances.ProcessTrace by removing all events.
MetaDataObject.
CollectionReader, after which it may no longer be used.
InputStream.
UIMAException.STANDARD_MESSAGE_CATALOG.
UIMAException.STANDARD_MESSAGE_CATALOG.
CollectionProcessingEngine (CPE) processes a collection of artifacts (for text
analysis applications, this will be a collection of documents) and produces collection-level
results.CollectionProcessingManager (CPM) manages the application of an
AnalysisEngine to a collection of artifacts.CollectionReader is used to iterate over the elements of a Collection.CollectionReaderDescription contains all of the information needed to
instantiate and use an CollectionReader.ResourceFactory that produces resources by delegating to other Resource
Factories.aCAS is an instanceof CAS.
aCAS is an instanceof JCas.
ResourceSpecifier that locates a resource file using its URL.Resource that has configuration parameters that can be changed after the Resource has
been instantiated.ConfigurableResources.ConfigurationParameters.Resource.ConfigurationParameters in a Resource.FSMatchConstraints for filtered iterators or other
use.ResultSpecification contains the specified Feature for
the language x-unspecified.
ResultSpecification contains the specified Feature for
the specified language.
ResultSpecification contains the specified Type for the
language x-unspecified.
ResultSpecification contains the specified Type for the
specified language.
file to location dir.
start to end to the
destination destArray with destination offset destOffset.
start to end to the
destination destArray with destination offset destOffset.
start to end to the
destination destArray with destination offset destOffset.
start to end to the
destination destArray with destination offset destOffset.
start to end to the
destination destArray with destination offset destOffset.
start to end to the
destination destArray with destination offset destOffset.
start to end to the
destination destArray with destination offset destOffset.
start to end to the
destination destArray with destination offset destOffset.
AllowedValue.
AnalysisEngineDescription.
AnalysisEngineMetaData.
Capability.
CapabilityLanguageFlow.
CasConsumerDescription.
CollectionReaderDescription.
ConfigurationGroup.
ConfigurationParameter.
ConfigurationParameterDeclarations.
ConfigurationParameterSettings.
CustomResourceSpecifier.
ExternalResourceBinding.
ExternalResourceDependency.
ExternalResourceDescription.
FeatureDescription.
FileLanguageResourceSpecifier.
FileResourceSpecifier.
FixedFlow.
FlowControllerDeclaration
FlowControllerDescription
FsIndexCollection.
FsIndexDescription.
FsIndexKeyDescription.
Import
mainComponentDir.
JMSMessagingSpecifier.
MailMessagingSpecifier.
MQMessagingSpecifier.
NameValuePair.
OperationalProperties
Parameter
PearSpecifier.
ProcessingResourceMetaData.
ResourceManagerConfiguration.
ResourceMetaData.
ResultSpecification for use with this
AnalysisEngine.
ResultSpecification for use with this
AnalysisEngine.
ResultSpecification.
SAXParser class and sets standard features.
SimplePrecondition.
CAS.createView(String) instead.
JCas.createView(String) instead.
SofaMapping.
ResourceSpecifierFactory.createAnalysisEngineDescription() should be used instead.
TypeDescription.
TypeOrFeature.
TypePriorities.
TypePriorityList.
TypeSystemDescription.
URISpecifier.
ResourceSpecifier that specifically names the
Java class that should be created.DataResource is a simple resource that provides access to data.FSIndexRepository.getAllIndexedFS(Type).
Properties
object.
BaseCollectionReader.close().
Resource.
CasProcessor in this CPM's list of CasProcessors.
DocumentAnnotation type.ResourceCreationSpecifier.
ResourceCreationSpecifier.
CAS.reset().
CollectionProcessingManager.f.
i.
FSIndexComparator
true iff the
comparators have the same keys and comparators.
DataResource is equal to another DataResource.
Throwable object.
ExternalResourceDependency to an
ExternalResourceDescription.ExternalResourceDependency object describes an resources's requirements on an
external resource.ExternalResourceDescription object describes a resource that is loaded in the
ResourceManager and may be shared between components.FileFilter object.
extractFilesFromPEARFile method, which allows
sending messages to the OUT and ERR queues.
extractPEARFile method, which allows sending
messages to the OUT and ERR queues.
Feature to an equivalent FeatureDescription.
FeaturePathResourceSpecifier that locates a resource file using its URL, where the
URL depends on an ISO language identifier.ResourceSpecifier that locates a resource file using its URL.FileUtil class provides utility methods for working with general files.DirFileFilter class allows to filter files based on specified directory path
and filename extension.DirFileFilter object for specified directory and file extension.
ExtFileFilter allows to filter file names based on the specified filename
extension.ExtFileFilter class for a given filename extension.
ExtFileFilter class for a given filename extension.
FileTimeComparator class allows comparing 'last modified' time in 2 given
File objects.NameFileFilter class allows to filter files based on specified file name.NameFileFilter object for a given file name.
finalize method.
FixedFlow is a simple type of FlowConstraints that specifies the
complete flow as a fixed sequence.FlowConstraints.
FlowConstraints object represents constraints on the order of execution of
delegate Analysis Engines within an aggregate Analysis Engine.UimaContext used by FlowController components.FlowControllerDescription contains all of the information needed to instantiate
and use a FlowController.reset() instead.
ListIterator around an FSListIterator.
ListIterator around an FSListIterator.
f.
i.
index.
index.
CasProcessorDeploymentParam instance
identified by aParamName.
CasProcessorExecArg instance located
with provided index.
CasProcessorDeploymentParam
CasProcessorExecArg instances.
CasProcessorExecArg arguments
CpeCollectionReader instances
representing ALL defined CollectionReaders.
CpeCasProcessor objects in processing
pipeline.
AnalysisEngine that is assigned to this CPM.
AnalysisEngine.
AnalysisEngineMetaData.
getFeatures() instead.
componentType.
Attributes for this style.
MetaDataObject.
Capabilities.
CAS), from which the AnalysisEngine obtains the
information to be processed, and to which the AnalysisEngine writes new annotation information.
CasConsumerss assigned to this CPM.
CasManager.addMetaData(ProcessingResourceMetaData).
CasDataInitializer.
CasProcessorExecArg argument idenitied by
a given position in the list.
CasProcessorss assigned to this CPM, in the order in which they will
be caleld by the CPM.
CasProcessorss in this CPE, in the order in which they will be
executed.
CpeCheckpoint object containing checkpoint
configuration ( checkpoint file, frequency of checkpoints )
Progress.getUnit().
ASB.
ASB.
CAS.setCurrentComponentInfo(ComponentInfo).
CasProcessorConfigurationParameterSettings
object containing overrides to parameter settings for this CAS Processor.
CasProcessorConfigurationParameterSettings
object containing overrides to parameter settings for this CollectionReader.
CasProcessorConfigurationParameterSettings
object containing overrides to parameter settings for this CasInitializer.
AnnotatorContext to be used by this Annotator.
CpeCasProcessor found at given position.
CpeCasProcessors instance containing
processing pipeline spec.
CpeComponentDescriptor instance associated with this Cas Processor.
UimaTimer interface.
DataResource object that can be used to access the data that is appropriate for
the given parameter values.
ResourceSpecifiers
that indicate which delegate AnalysisEngines comprise the aggregate.
ResourceSpecifiers
that indicate which delegate AnalysisEngines comprise the aggregate.
Import or ResourceSpecifier objects.
Hashtable that contains (compId, InsD) pairs for all separate delegate
components specified in a given installation table.
CasProcessorDeploymentParams object
containing deployment parameters used for launching CasProcessor.
CpeComponentDescriptor containing
CollectionReader descriptor path.
CpeComponentDescriptor containing
CasInitializer descriptor path.
getDirectSubtypes(Type) instead.
CasProcessorErrorHandling object containing
strategies to deal with errors that may occur during processing.
ProcessTraceEvents, in the order in which they were created.
CasProcessorExecutable program used by the
CPE to launch CasProcessor.
ExternalResourceDependencies and
the ExternalResourceDescription objects defined in this
configuration.
ResourceCreationSpecifier's dependencies on external resources.
Filter that identifies which instances of the named CAS type are
governed by the index rule for this item.
FlowConstraints object.
FlowConstraints object.
FlowConstraints object.
FlowControllerContainer known to this ASB.
ResourceCreationSpecifier's implementation.
ResourceManagerConfiguration.getImports() instead. There may be many imports; this method only
returns the first.
IndexBuildItem objects that comprise this index build specification.
IndexRule that defines how annotations matching this build item should
be indexed.
InputStream to the data.
ActionInfo objects that have a given action name.
INSTALLATION_DESCRIPTOR_FILE file, and creates the
InstallationDescriptor (InsD) object.
InputStream object (for use in Eclipse plug-in).
PackageSelector input.
UIMAFramework instance currently in use.
InstrumentationFacility that this annotator can use to record
information about its performance.
InstrumentationFacility that a component can use to record information
about its performance.
CAS.getView(String) followed by CAS.getJCas().
ExternalResourceDependency being bound.
Capability and
returns the ISO language identifiers that the Resource supports.
Exception object associated with a given XML descriptor
file.
Exception object associated with a given XML descriptor
URL.
Locale.
Locale.
Logger to which this annotator should send its log output.
Logger to which log output will be sent.
Logger used by the UIMA framework.
Logger used by a particular Class, for example an
Annotator.
null, if the main component was not specified.
null, if the main component was not specified.
null, if the main component was not specified.
null, if the main component was not specified.
Resource.
ResourceMetaData to assign to the newly constructed ResourceCreationSpecifier.
Capability and
returns the MIME types that the Resource can take as input.
ConfigurationGroup object.
- getNext() -
Method in interface org.apache.uima.collection.base_cpm.CasDataCollectionReader
- Gets the next
CasData from this CollectionReader.
- getNext(int) -
Method in interface org.apache.uima.collection.base_cpm.CasDataCollectionReader
- Gets multiple
CasData objects from this CasDataCollectionReader.
- getNext(CAS) -
Method in interface org.apache.uima.collection.CollectionReader
- Gets the next element of the collection.
- getNextSibling() -
Method in interface org.apache.uima.cas.text.AnnotationTreeNode
- Get the next sibling (to the right) of this node.
- getNonsharedMulitValuedFSs() -
Method in class org.apache.uima.cas.impl.XmiSerializationSharedData
-
- getNthElement(int) -
Method in class org.apache.uima.jcas.cas.FloatList
-
- getNthElement(int) -
Method in class org.apache.uima.jcas.cas.FSList
-
- getNthElement(int) -
Method in class org.apache.uima.jcas.cas.IntegerList
-
- getNthElement(int) -
Method in class org.apache.uima.jcas.cas.StringList
-
- getNumAvailable() -
Method in class org.apache.uima.util.CasPool
- Gets the number of CASes currently available in this pool.
- getNumberOfCASesProcessed() -
Method in interface org.apache.uima.analysis_engine.AnalysisEngineManagement
- Gets the total number of CASes this AnalysisEngine has processed over its lifetime.
- getNumberOfFeatures() -
Method in interface org.apache.uima.cas.Type
- Get the number of features for which this type defines the domain.
- getNumberOfKeys() -
Method in interface org.apache.uima.cas.admin.FSIndexComparator
- Return the number of keys.
- getNumberOfRegisteredClasses() -
Static method in class org.apache.uima.jcas.JCasRegistry
- Gets the number of cover classes that have been registered.
- getNumChildren() -
Method in class org.apache.uima.cas.impl.XCASSerializer
-
- getNumChildren() -
Method in class org.apache.uima.cas.impl.XmiCasSerializer
- Gets the number of children of the current element.
- getNumToProcess() -
Method in interface org.apache.uima.collection.metadata.CpeConfiguration
- Returns number of entities to process
- getObject() -
Method in interface org.apache.uima.util.SaxDeserializer
- Retrieves the
XMLizable object that has been built from the SAX events this object has
already received.
- getOffsetInSource() -
Method in class org.apache.uima.examples.SourceDocumentInformation
- getter for offsetInSource - gets Byte offset of the start of document content within original
source file or other input source.
- getOffsetInSource(int) -
Method in class org.apache.uima.examples.SourceDocumentInformation_Type
-
- getOperationalProperties() -
Method in interface org.apache.uima.resource.metadata.ProcessingResourceMetaData
- Gets this Processing Resource's
OperationalProperties.
- getOrder() -
Method in interface org.apache.uima.cas.admin.LinearTypeOrder
-
- getOrder() -
Method in interface org.apache.uima.cas.admin.LinearTypeOrderBuilder
- Return a total order of the type names added earlier that is consistent with the pre-order
defined through calls to add().
- getOSSpecs() -
Method in class org.apache.uima.pear.tools.InstallationDescriptor
-
- getOutMsgWriter() -
Method in class org.apache.uima.pear.tools.InstallationController
-
- getOutOfTypeSystemArrayElements(int) -
Method in class org.apache.uima.cas.impl.XmiSerializationSharedData
- Gets information about out-of-typesystem array elements.
- getOutOfTypeSystemElements() -
Method in class org.apache.uima.cas.impl.XmiSerializationSharedData
- Gets a List of
OotsElementData objects, each of which describes an
incoming XMI element that did not correspond to a Type in the TypeSystem.
- getOutOfTypeSystemFeatures(int) -
Method in class org.apache.uima.cas.impl.XmiSerializationSharedData
- Gets information about out-of-typesystem features that belong to an
in-typesystem FS.
- getOutOfTypeSystemViewMembers(String) -
Method in class org.apache.uima.cas.impl.XmiSerializationSharedData
- Gets a List of xmi:id's (Strings) of all out-of-typesystem XMI elements
that are members of the view with the given id.
- getOutputQueue() -
Method in interface org.apache.uima.collection.metadata.CpeConfiguration
-
- getOutputQueueSize() -
Method in interface org.apache.uima.collection.metadata.CpeCasProcessors
- Returns the size of the OutputQueue.
- getOutputs() -
Method in interface org.apache.uima.resource.metadata.Capability
- Gets the outputs of this Capability.
- getOutputsNewCASes() -
Method in interface org.apache.uima.resource.metadata.OperationalProperties
- Gets whether this AnalysisEngine may output new CASes.
- getOutputSofas() -
Method in interface org.apache.uima.resource.metadata.Capability
- Gets the output Sofa names of this Capability.
- getOverrides() -
Method in interface org.apache.uima.resource.metadata.ConfigurationParameter
- Gets the parameters that are this parameter overrides.
- getParameterName() -
Method in interface org.apache.uima.collection.metadata.CasProcessorDeploymentParam
- Returns the name of the parameter
- getParameters() -
Method in interface org.apache.uima.resource.CustomResourceSpecifier
- Gets parameters that may be read by the custom resource class when it is initialized.
- getParameters() -
Method in interface org.apache.uima.resource.PearSpecifier
- Gets parameters that may be read by the pear resource class when it is initialized.
- getParameters() -
Method in interface org.apache.uima.resource.URISpecifier
-
- getParameterSettings() -
Method in interface org.apache.uima.collection.metadata.CasProcessorConfigurationParameterSettings
- Gets the settings for configuration parameters that are not in any group.
- getParameterSettings() -
Method in interface org.apache.uima.resource.metadata.ConfigurationParameterSettings
- Gets the settings for configuration parameters that are not in any group.
- getParameterType() -
Method in interface org.apache.uima.collection.metadata.CasProcessorDeploymentParam
- Returns deployment parameter value type
- getParameterValue(String) -
Method in interface org.apache.uima.collection.metadata.CasProcessorConfigurationParameterSettings
- Looks up the value of a parameter.
- getParameterValue() -
Method in interface org.apache.uima.collection.metadata.CasProcessorDeploymentParam
- Returns deployment parameter value
- getParameterValue(String) -
Method in interface org.apache.uima.resource.metadata.ConfigurationParameterSettings
- Looks up the value of a parameter.
- getParameterValue(String, String) -
Method in interface org.apache.uima.resource.metadata.ConfigurationParameterSettings
- Looks up the value of a parameter in a group.
- getParent() -
Method in interface org.apache.uima.cas.text.AnnotationTreeNode
- Get the parent of this node.
- getParent(Type) -
Method in interface org.apache.uima.cas.TypeSystem
- Get the parent type for input type.
- getPathComponents(String) -
Static method in class org.apache.uima.util.FileUtils
- Splits a path into components using the OS file separator character.
- getPEARFileLocation(String, InstallationController.PackageSelector) -
Static method in class org.apache.uima.pear.tools.InstallationController
- Gets the PEAR file location (file path or URL) for a given component by using SITH DB a given
PackageSelector input.
- getPearPath() -
Method in interface org.apache.uima.resource.PearSpecifier
- Retrieves the PEAR path at which the pear Resource is located.
- getPerformanceReport() -
Method in interface org.apache.uima.collection.base_cpm.BaseCPM
- Gets a performance report for the processing that is currently occurring or has just completed.
- getPerformanceReport() -
Method in interface org.apache.uima.collection.CollectionProcessingEngine
- Gets a performance report for the processing that is currently occurring or has just completed.
- getPerformanceReport() -
Method in interface org.apache.uima.collection.CollectionProcessingManager
- Gets a performance report for the processing that is currently occurring or has just completed.
- getPerformanceTuningSettings() -
Method in interface org.apache.uima.analysis_engine.AnalysisEngine
- Gets the performance tuning settings in effect for this Analysis Engine.
- getPlainClassName(Class<?>) -
Static method in class org.apache.uima.pear.util.StringUtil
- Returns a plain name (without package name) of a given Java
Class.
- getPoolSize() -
Method in interface org.apache.uima.util.CasPoolManagement
- Get the total size of the CAS Pool.
- getPreconditions() -
Method in interface org.apache.uima.resource.metadata.Capability
- Retrieves the preconditions that must be satisfied in order for the Resource to begin
processing.
- getPreconditionType() -
Method in interface org.apache.uima.resource.metadata.Precondition
- Gets the type of this precondition.
- getPreconditionType() -
Method in interface org.apache.uima.resource.metadata.SimplePrecondition
- Gets the type of this precondition.
- getPredicate() -
Method in interface org.apache.uima.resource.metadata.SimplePrecondition
- Retrieves the predicate used to compare the test value to the comparison value.
- getPreviousSibling() -
Method in interface org.apache.uima.cas.text.AnnotationTreeNode
- Get the previous sibling (to the left) of this node.
- getPriorityLists() -
Method in interface org.apache.uima.resource.metadata.TypePriorities
- Gets the
TypePriorityLists that define the priorities.
- getProcess() -
Method in class org.apache.uima.pear.util.ProcessUtil.Runner
-
- getProcessingResourceMetaData() -
Method in interface org.apache.uima.collection.base_cpm.BaseCollectionReader
- Gets the metadata that describes this
CasProcesor.
- getProcessingResourceMetaData() -
Method in class org.apache.uima.collection.base_cpm.CasDataCollectionReader_ImplBase
-
- getProcessingResourceMetaData() -
Method in class org.apache.uima.collection.base_cpm.CasDataConsumer_ImplBase
-
- getProcessingResourceMetaData() -
Method in class org.apache.uima.collection.base_cpm.CasDataInitializer_ImplBase
- Deprecated.
- getProcessingResourceMetaData() -
Method in interface org.apache.uima.collection.base_cpm.CasProcessor
- Gets the metadata that describes this
CasProcesor.
- getProcessingResourceMetaData() -
Method in class org.apache.uima.collection.CasConsumer_ImplBase
-
- getProcessingResourceMetaData() -
Method in interface org.apache.uima.collection.CasInitializer
- Deprecated. Gets the metadata that describes this
CasInitializer.
- getProcessingResourceMetaData() -
Method in class org.apache.uima.collection.CasInitializer_ImplBase
- Deprecated.
- getProcessingResourceMetaData() -
Method in class org.apache.uima.collection.CollectionReader_ImplBase
- Gets the metadata for this CollectionReader, which was extracted from the descriptor during
initialization.
- getProcessingResourceMetaData() -
Method in class org.apache.uima.resource.CasDefinition
- Constructs and returns a
ProcessingResourceMetaData object
that contains the type system, indexes, and type priorities definitions
for the CAS.
- getProcessTrace() -
Method in interface org.apache.uima.analysis_engine.AnalysisProcessData
- Deprecated. Gets the
ProcessTrace object, which is used to record which AnalysisEngine components
have executed and information, such as timing, about that execution.
- getProcessTrace() -
Method in interface org.apache.uima.collection.EntityProcessStatus
- Gets the
ProcessTrace object for the Entity's processing.
- getProgress() -
Method in interface org.apache.uima.collection.base_cpm.BaseCollectionReader
- Gets information about the number of entities and/or amount of data that has been read from
this
CollectionReader, and the total amount that remains (if that information
is available).
- getProgress() -
Method in interface org.apache.uima.collection.base_cpm.BaseCPM
- Gets a progress report for the processing that is currently occurring or has just completed.
- getProgress() -
Method in interface org.apache.uima.collection.CollectionProcessingEngine
- Gets a progress report for the processing that is currently occurring or has just completed.
- getProgress() -
Method in interface org.apache.uima.collection.CollectionProcessingManager
- Gets a progress report for the processing that is currently occurring or has just completed.
- getProperlySubsumedTypes(Type) -
Method in interface org.apache.uima.cas.TypeSystem
- Return the list of all types subsumed by the input type.
- getProtocol() -
Method in interface org.apache.uima.resource.URISpecifier
- Gets the name of the Protocol used to communicate with the service.
- getQualifiedContextName() -
Method in interface org.apache.uima.UimaContextAdmin
- Gets the fully-qualified name of this context.
- getQueueClass() -
Method in interface org.apache.uima.collection.metadata.OutputQueue
- Class name of the queue object to be used as Output Queue
- getRange() -
Method in interface org.apache.uima.cas.Feature
- Get the range type for this feature.
- getRangeTypeName() -
Method in interface org.apache.uima.resource.metadata.FeatureDescription
- Gets the name of the range Type of this Feature.
- getRelativePath(File, String) -
Static method in class org.apache.uima.pear.util.FileUtil
- Constructs a relative path of a given object, located in a given root directory, based on its
absolute path.
- getRelativePathBase() -
Method in class org.apache.uima.util.XMLInputSource
- Deprecated. Use
XMLInputSource.getURL() instead.
- getRelativePathForComponentObject(String, InstallationDescriptor.ComponentInfo) -
Static method in class org.apache.uima.pear.tools.InstallationDescriptor
- Constructs a relative path of a given component object, based on its absolute path.
- getRequiredCasInterface() -
Method in interface org.apache.uima.analysis_component.AnalysisComponent
- Returns the specific CAS interface that this AnalysisComponent requires the framework to pass
to its
AnalysisComponent.process(AbstractCas) method.
- getRequiredCasInterface() -
Method in class org.apache.uima.analysis_component.CasAnnotator_ImplBase
-
- getRequiredCasInterface() -
Method in class org.apache.uima.analysis_component.CasMultiplier_ImplBase
-
- getRequiredCasInterface() -
Method in class org.apache.uima.analysis_component.JCasAnnotator_ImplBase
-
- getRequiredCasInterface() -
Method in class org.apache.uima.analysis_component.JCasMultiplier_ImplBase
-
- getRequiredCasInterface() -
Method in class org.apache.uima.flow.CasFlowController_ImplBase
-
- getRequiredCasInterface() -
Method in interface org.apache.uima.flow.FlowController
- Returns the specific CAS interface that this FlowController requires the framework to pass to
its
FlowController.computeFlow(AbstractCas) method.
- getRequiredCasInterface() -
Method in class org.apache.uima.flow.JCasFlowController_ImplBase
-
- getRequiredCasInterface() -
Method in class org.apache.uima.uimacpp.UimacppAnalysisComponent
-
- getRequiredFeature(Type, String) -
Method in interface org.apache.uima.jcas.JCas
- Internal use - look up a feature-name-string in the CAS type system and returns the Cas Feature
object.
- getRequiredFeatureDE(Type, String, String, boolean) -
Method in interface org.apache.uima.jcas.JCas
- Internal Use - look up a feature-name-string in the CAS type system and returns the Cas Feature
object.
- getRequiredType(String) -
Method in interface org.apache.uima.jcas.JCas
- Internal use - looks up a type-name-string in the CAS type system and returns the Cas Type
object.
- getResolution() -
Method in interface org.apache.uima.util.UimaTimer
- Gets the timer resolution in milliseconds.
- getResource(String) -
Method in interface org.apache.uima.resource.ResourceManager
- Gets the Resource that has been registered under the specified name.
- getResource(String, String[]) -
Method in interface org.apache.uima.resource.ResourceManager
- Gets an instance of a parameterized Resource.
- getResourceAsStream(String) -
Method in interface org.apache.uima.analysis_engine.annotator.AnnotatorContext
- Deprecated. Retrieves an InputStream for reading from the named resource.
- getResourceAsStream(String, String[]) -
Method in interface org.apache.uima.analysis_engine.annotator.AnnotatorContext
- Deprecated. Retrieves an InputStream for reading from the named resource.
- getResourceAsStream(String) -
Method in interface org.apache.uima.resource.ResourceManager
- Retrieves an InputStream for reading from the named resource.
- getResourceAsStream(String, String[]) -
Method in interface org.apache.uima.resource.ResourceManager
- Retrieves an InputStream for reading from the named resource.
- getResourceAsStream(String) -
Method in interface org.apache.uima.UimaContext
- Retrieves an InputStream for reading from the named resource.
- getResourceAsStream(String, String[]) -
Method in interface org.apache.uima.UimaContext
- Retrieves an InputStream for reading from the named resource.
- getResourceBundleName() -
Method in exception org.apache.uima.InternationalizedException
- Gets the base name of the resource bundle in which the message for this
exception is located.
- getResourceBundleName() -
Method in exception org.apache.uima.InternationalizedRuntimeException
- Gets the base name of the resource bundle in which the message for this exception is located.
- getResourceClass(String) -
Method in interface org.apache.uima.resource.ResourceManager
- Gets the Class of the Resource that will be returned by a call to
ResourceManager.getResource(String)
or ResourceManager.getResource(String,String[]).
- getResourceClassName() -
Method in interface org.apache.uima.resource.CustomResourceSpecifier
- Retrieves the name of the Java class that will be instantiated when
one of the
UIMAFramework.produceXXX(ResourceSpecifier,...) methods is called
with this resource specifier.
- getResourceFactory() -
Static method in class org.apache.uima.UIMAFramework
- Get a reference to the
ResourceFactory.
- getResourceFilePath(String) -
Method in interface org.apache.uima.analysis_engine.annotator.AnnotatorContext
- Deprecated. Retrieves the absolute file path to the named resource.
- getResourceFilePath(String, String[]) -
Method in interface org.apache.uima.analysis_engine.annotator.AnnotatorContext
- Deprecated. Retrieves the absolute file path to the named resource.
- getResourceFilePath(String) -
Method in interface org.apache.uima.UimaContext
- Retrieves the absolute file path to the named resource.
- getResourceFilePath(String, String[]) -
Method in interface org.apache.uima.UimaContext
- Retrieves the absolute file path to the named resource.
- getResourceManager() -
Method in interface org.apache.uima.analysis_engine.AnalysisEngine
- Gets the
ResourceManager used by this AnalysisEngine.
- getResourceManager() -
Method in class org.apache.uima.resource.CasDefinition
-
- getResourceManager() -
Method in interface org.apache.uima.resource.Resource
- Gets the
ResourceManager that this Resource uses to locate other Resources.
- getResourceManager() -
Method in class org.apache.uima.resource.Resource_ImplBase
-
- getResourceManager() -
Method in interface org.apache.uima.UimaContextAdmin
- Gets the ResourceManager instance used by this UimaContext to resolve external resource
accesses.
- getResourceManagerConfiguration() -
Method in interface org.apache.uima.collection.metadata.CpeDescription
- Returns ResourceManagerConfiguration instance.
- getResourceManagerConfiguration() -
Method in interface org.apache.uima.resource.ResourceCreationSpecifier
- Retrieves the Resource Manager configuration, which declares the resources that satisfy the
dependencies defined by
ResourceCreationSpecifier.getExternalResourceDependencies().
- getResourceName() -
Method in interface org.apache.uima.resource.metadata.ExternalResourceBinding
- Retrieves the name of the actual Resource instance that will satisfy this dependency.
- getResourceObject(String) -
Method in interface org.apache.uima.analysis_engine.annotator.AnnotatorContext
- Deprecated. Retrieves the named resource object.
- getResourceObject(String, String[]) -
Method in interface org.apache.uima.analysis_engine.annotator.AnnotatorContext
- Deprecated. Retrieves the named resource object.
- getResourceObject(String) -
Method in interface org.apache.uima.UimaContext
- Retrieves the named resource object.
- getResourceObject(String, String[]) -
Method in interface org.apache.uima.UimaContext
- Retrieves the named resource object.
- getResourceSpecifier() -
Method in interface org.apache.uima.resource.ExternalResourceDescription
- Retrieves the
ResourceSpecifier that describes how to create the resource.
- getResourceSpecifierFactory() -
Static method in class org.apache.uima.UIMAFramework
- Get a reference to the
ResourceSpecifierFactory.
- getResourceSpecifiers() -
Method in interface org.apache.uima.resource.ResourceSpecifierList
- Retrieves the constituent
ResourceSpecifiers that comprise this aggregate
ResourceSpecifierList.
- getResourceType() -
Method in interface org.apache.uima.resource.URISpecifier
- Retrieves the type of Resource (e.g.
- getResourceURI(String) -
Method in interface org.apache.uima.analysis_engine.annotator.AnnotatorContext
- Deprecated. Retrieves the URI to the named resource.
- getResourceURI(String, String[]) -
Method in interface org.apache.uima.analysis_engine.annotator.AnnotatorContext
- Deprecated. Retrieves the URI to the named resource.
- getResourceURI(String) -
Method in interface org.apache.uima.UimaContext
- Retrieves the URI to the named resource.
- getResourceURI(String, String[]) -
Method in interface org.apache.uima.UimaContext
- Retrieves the URI to the named resource.
- getResourceURL(String) -
Method in interface org.apache.uima.analysis_engine.annotator.AnnotatorContext
- Deprecated. Retrieves the URL to the named resource.
- getResourceURL(String, String[]) -
Method in interface org.apache.uima.analysis_engine.annotator.AnnotatorContext
- Deprecated. Retrieves the URL to the named resource.
- getResourceURL(String) -
Method in interface org.apache.uima.resource.ResourceManager
- Retrieves the URL to the named resource.
- getResourceURL(String, String[]) -
Method in interface org.apache.uima.resource.ResourceManager
- Retrieves the URL to the named resource.
- getResourceURL(String) -
Method in interface org.apache.uima.UimaContext
- Retrieves the URL to the named resource.
- getResourceURL(String, String[]) -
Method in interface org.apache.uima.UimaContext
- Retrieves the URL to the named resource.
- getRestartCount() -
Method in interface org.apache.uima.collection.metadata.CasProcessorMaxRestarts
- Returns max restarts threshold fro CasProcessor
- getResultMessage() -
Method in interface org.apache.uima.util.ProcessTraceEvent
- Retrieves the result message of this event.
- getResultSpecification() -
Method in class org.apache.uima.analysis_component.AnalysisComponent_ImplBase
- Gets the ResultSpecification for this AnalysisComponent.
- getResultSpecification() -
Method in class org.apache.uima.flow.SimpleStepWithResultSpec
- Deprecated. Gets the key of the Analysis Engine to which the CAS should be routed.
- getResultTypesAndFeatures() -
Method in interface org.apache.uima.analysis_engine.ResultSpecification
- Retrieves the Types and Features that the AnalysisEngine or Annotator is requested to produce
for the default language x-unspecified (that is, regardless any language specification).
- getResultTypesAndFeatures(String) -
Method in interface org.apache.uima.analysis_engine.ResultSpecification
- Retrieves the Types and Features that the AnalysisEngine or Annotator is requested to produce
for the specified language.
- getRetCode() -
Method in class org.apache.uima.pear.tools.InstallationController.TestStatus
-
- getRoot() -
Method in interface org.apache.uima.cas.text.AnnotationTree
- Get the root node of the tree.
- getRootContext() -
Method in interface org.apache.uima.UimaContextAdmin
- Gets the Root Context for this Resource.
- getRootDirectory() -
Method in class org.apache.uima.pear.tools.PackageBrowser
-
- getRunInSeparateProcess() -
Method in interface org.apache.uima.collection.metadata.CpeCasProcessor
-
- getRunInSeperateProcess() -
Method in interface org.apache.uima.collection.metadata.CpeLocalCasProcessor
-
- getSearchStrategy() -
Method in interface org.apache.uima.resource.metadata.ConfigurationParameterDeclarations
- Gets the configuration parameter search strategy.
- getServiceCallOverhead() -
Method in class org.apache.uima.util.AnalysisEnginePerformanceReports
-
- getServiceCallTime() -
Method in interface org.apache.uima.analysis_engine.AnalysisEngineManagement
- If this AnalysisEngine is a proxy to a remote service, gets the total time spent making calls
on that service.
- getServiceWrapperOverhead() -
Method in class org.apache.uima.util.AnalysisEnginePerformanceReports
-
- getSession() -
Method in interface org.apache.uima.UimaContext
- Returns the Session object, which can be used to store data that pertains to a particular
client session.
- getSettingsForGroups() -
Method in interface org.apache.uima.resource.metadata.ConfigurationParameterSettings
- Gets the settings for configuration parameters that are defined within groups.
- getShortHeap() -
Method in class org.apache.uima.uimacpp.CppUimajEngine
-
- getShortName() -
Method in interface org.apache.uima.cas.Feature
- Get the unqualified, short name of this feature.
- getShortName() -
Method in interface org.apache.uima.cas.Type
- Get the unqualified, short name of this type.
- getShortValue(FeatureStructure) -
Method in interface org.apache.uima.cas.FeaturePath
- Returns the Short value of a short valued feature path.
- getShortValue(Feature) -
Method in interface org.apache.uima.cas.FeatureStructure
- Get the short value of a feature.
- getSize() -
Method in class org.apache.uima.util.CasPool
- Gets the size of this pool (the total number of CAS instances that it can hold).
- getSize() -
Method in class org.apache.uima.util.JCasPool
- Gets the size of this pool (the total number of JCas instances that it can hold).
- getSofa(SofaID) -
Method in interface org.apache.uima.cas.CAS
- Deprecated. As of v2.0, use {#getView(String)}. From the view you can access the Sofa data, or
call
CAS.getSofa() if you truly need to access the SofaFS object.
- getSofa() -
Method in interface org.apache.uima.cas.CAS
- Get the Sofa feature structure associated with this CAS view.
- getSOFA() -
Method in interface org.apache.uima.collection.metadata.CpeCasProcessor
-
- getSofa() -
Method in class org.apache.uima.jcas.cas.AnnotationBase
- getter for sofa - gets Sofaref for annotation
- getSofa(int) -
Method in class org.apache.uima.jcas.cas.AnnotationBase_Type
-
- getSofa(SofaID) -
Method in interface org.apache.uima.jcas.JCas
- Deprecated. As of v2.0, use {#getView(String)}. From the view you can access the Sofa data, or
call
JCas.getSofa() if you truly need to access the SofaFS object.
- getSofa() -
Method in interface org.apache.uima.jcas.JCas
- Get the Sofa feature structure associated with this JCas view.
- getSofaDataArray() -
Method in interface org.apache.uima.cas.CAS
- Get the Sofa data array.
- getSofaDataArray() -
Method in interface org.apache.uima.jcas.JCas
- Get the Sofa data array.
- getSofaDataStream() -
Method in interface org.apache.uima.cas.CAS
- Get the Sofa data as a byte stream.
- getSofaDataStream() -
Method in interface org.apache.uima.cas.SofaFS
- Provides stream access to both local and remote Sofa data.
- getSofaDataStream() -
Method in class org.apache.uima.jcas.cas.Sofa
-
- getSofaDataStream() -
Method in interface org.apache.uima.jcas.JCas
- Get the Sofa data as a byte stream.
- getSofaDataString() -
Method in interface org.apache.uima.cas.CAS
- Get the Sofa Data String (a.k.a.
- getSofaDataString() -
Method in interface org.apache.uima.jcas.JCas
- Get the Sofa Data String (a.k.a.
- getSofaDataURI() -
Method in interface org.apache.uima.cas.CAS
- Get the Sofa data array.
- getSofaDataURI() -
Method in interface org.apache.uima.jcas.JCas
- Get the Sofa data array.
- getSofaID() -
Method in interface org.apache.uima.cas.SofaFS
- Get the Sofa globally unique name, after mapping.
- getSofaID() -
Method in interface org.apache.uima.cas.SofaID
- Deprecated. Get the Sofa ID.
- getSofaID() -
Method in class org.apache.uima.jcas.cas.Sofa
- getter for sofaID - gets
- getSofaIterator() -
Method in interface org.apache.uima.cas.CAS
- Get iterator for all SofaFS in the CAS.
- getSofaIterator() -
Method in interface org.apache.uima.jcas.JCas
- Get iterator for all SofaFS in the CAS.
- getSofaMap() -
Method in interface org.apache.uima.UimaContextAdmin
- Gets an unmodifiable Map containing the mapping of component sofa name to
absolute sofa ID.
- getSofaMappings() -
Method in interface org.apache.uima.analysis_engine.AnalysisEngineDescription
- Reserved for future use.
- getSofaMappings() -
Method in interface org.apache.uima.analysis_engine.annotator.AnnotatorContext
- Deprecated. As of v2.0, annotators no longer need to explicitly call this method. CAS views can
now be obtained directly by the method
CAS.getView(String), and the
framework will automatically do the necessary Sofa mappings.
- getSofaMappings() -
Method in interface org.apache.uima.UimaContext
- Deprecated. As of v2.0, annotators no longer need to explicitly call this method. CAS views can
now be obtained directly by the method
CAS.getView(String), and the
framework will automatically do the necessary Sofa mappings.
- getSofaMime() -
Method in interface org.apache.uima.cas.SofaFS
- Get the Sofa mime type.
- getSofaMime() -
Method in class org.apache.uima.jcas.cas.Sofa
-
- getSofaMimeType() -
Method in interface org.apache.uima.cas.CAS
- Get the mime type of the Sofa data being analyzed.
- getSofaMimeType() -
Method in interface org.apache.uima.jcas.JCas
- Get the mime type of the Sofa data being analyzed.
- getSofaNameMappings() -
Method in interface org.apache.uima.collection.metadata.CpeCasProcessor
-
- getSofaNameMappings() -
Method in interface org.apache.uima.collection.metadata.CpeCollectionReaderCasInitializer
- Deprecated.
- getSofaNameMappings() -
Method in interface org.apache.uima.collection.metadata.CpeCollectionReaderIterator
-
- getSofaNameMappings() -
Method in interface org.apache.uima.collection.metadata.CpeSofaMappings
- Return Sofa Name Mappings
- getSofaNum() -
Method in class org.apache.uima.jcas.cas.Sofa
- getter for sofaNum - gets
- getSofaRef() -
Method in interface org.apache.uima.cas.SofaFS
- Get the Sofa Ref value.
- getSofaRef() -
Method in class org.apache.uima.jcas.cas.Sofa
-
- getSofaURI() -
Method in interface org.apache.uima.cas.SofaFS
- Get the Sofa URI value.
- getSofaURI() -
Method in class org.apache.uima.jcas.cas.Sofa
-
- getSourceUrl() -
Method in interface org.apache.uima.resource.metadata.MetaDataObject
- Gets the URL from which this object was parsed.
- getSourceUrlString() -
Method in interface org.apache.uima.resource.metadata.MetaDataObject
- If the sourceURL of this object is non-null, returns its string representation.
- getSpecifier() -
Method in interface org.apache.uima.analysis_engine.metadata.FlowControllerDeclaration
- Retrieves the
ResourceSpecifier used to determine which FlowController is used
by the AnalysisEngine.
- getStart() -
Method in class org.apache.uima.jcas.tcas.Annotation
- Deprecated.
- getStartingEntityId() -
Method in interface org.apache.uima.collection.metadata.CpeConfiguration
- Returns id of the first entity the CPE will beging processing.
- getStatusMessage() -
Method in interface org.apache.uima.collection.EntityProcessStatus
- Gets a message describing the status of the Entity's processing.
- getStdOutput() -
Method in class org.apache.uima.pear.util.ProcessUtil.Runner
-
- getString() -
Method in interface org.apache.uima.resource.metadata.AllowedValue
- Gets the allowed value.
- getStringArray0L() -
Method in interface org.apache.uima.jcas.JCas
- A constant for each cas which holds a 0-length instance.
- getStringFeatValue(CAS, String, String) -
Static method in class org.apache.uima.util.ConsumerCasUtils
-
- getStringTable() -
Method in class org.apache.uima.uimacpp.CppUimajEngine
-
- getStringValue(FeatureStructure) -
Method in interface org.apache.uima.cas.FeaturePath
- Returns the String value of a string valued feature path.
- getStringValue(Feature) -
Method in interface org.apache.uima.cas.FeatureStructure
- Get the string value under a feature.
- getStyles() -
Method in interface org.apache.uima.search.IndexRule
- Gets the styles that comprise this index rule.
- getSubDirs(File) -
Static method in class org.apache.uima.util.FileUtils
- Get a list of all subdirectories in a directory, ignoring regular files.
- getSubEvents() -
Method in interface org.apache.uima.util.ProcessTraceEvent
- Gets the sub-events of this event.
- getSupertypeName() -
Method in interface org.apache.uima.resource.metadata.TypeDescription
- Gets the name of the supertype for this Type.
- getSynchPoint() -
Method in interface org.apache.uima.collection.base_cpm.RecoverableCollectionReader
- Retrieves data facilitating recovery of the CollectionReader
- getSyntax() -
Method in interface org.apache.uima.search.Filter
- Gets the declared syntax for this filter's expression.
- getTafJNIVersion() -
Static method in class org.apache.uima.uimacpp.UimacppEngine
- helper function to get the TAF JNI version.
- getTail() -
Method in class org.apache.uima.jcas.cas.NonEmptyFloatList
- getter for tail *
- getTail(int) -
Method in class org.apache.uima.jcas.cas.NonEmptyFloatList_Type
-
- getTail() -
Method in class org.apache.uima.jcas.cas.NonEmptyFSList
- getter for tail *
- getTail(int) -
Method in class org.apache.uima.jcas.cas.NonEmptyFSList_Type
-
- getTail() -
Method in class org.apache.uima.jcas.cas.NonEmptyIntegerList
- getter for tail *
- getTail(int) -
Method in class org.apache.uima.jcas.cas.NonEmptyIntegerList_Type
-
- getTail() -
Method in class org.apache.uima.jcas.cas.NonEmptyStringList
- getter for tail *
- getTail(int) -
Method in class org.apache.uima.jcas.cas.NonEmptyStringList_Type
-
- getTargetAddress() -
Method in interface org.apache.uima.resource.MessagingSpecifier
- Returns the targetAddress.
- getTargetId() -
Method in interface org.apache.uima.cas_data.ReferenceValue
- Gets the ID of the target FeatureStructure.
- getTargetImapPort() -
Method in interface org.apache.uima.resource.MailMessagingSpecifier
- Returns the targetImapPort.
- getTargetInitialContextFactory() -
Method in interface org.apache.uima.resource.JMSMessagingSpecifier
- Returns the targetInitialContextFactory.
- getTargetMessagingServer() -
Method in interface org.apache.uima.resource.MessagingSpecifier
- Returns the targetMessagingServer.
- getTargetPassword() -
Method in interface org.apache.uima.resource.MessagingSpecifier
- Returns the targetPassword.
- getTargetProviderURL() -
Method in interface org.apache.uima.resource.JMSMessagingSpecifier
- Returns the targetProviderURL.
- getTargetServerChannelPort() -
Method in interface org.apache.uima.resource.MQMessagingSpecifier
- Returns the target serverChannelPort.
- getTargetSmtpPort() -
Method in interface org.apache.uima.resource.MailMessagingSpecifier
- Returns the targetSmtpPort.
- getTargetUser() -
Method in interface org.apache.uima.resource.MessagingSpecifier
- Returns the targetUser.
- getTcasFS(CAS, String) -
Static method in class org.apache.uima.util.ConsumerCasUtils
-
- getTerritoryPart() -
Method in class org.apache.uima.cas.text.Language
-
- getThrottleID() -
Method in exception org.apache.uima.collection.impl.cpm.engine.CPMChunkTimeoutException
-
- getTimeInMicros() -
Method in interface org.apache.uima.util.UimaTimer
- Gets the current time in microseconds.
- getTimeInMillis() -
Method in interface org.apache.uima.util.UimaTimer
- Gets the current time in milliseconds.
- getTimeInSecs() -
Method in interface org.apache.uima.util.UimaTimer
- Gets the current time in seconds.
- getTimeout() -
Method in interface org.apache.uima.collection.metadata.CasProcessorErrorHandling
- Returns the timeout the CPE will wait for a response from CasProcessor.
- getTimeout() -
Method in interface org.apache.uima.collection.metadata.CpeCasProcessor
- Returns the timeout value.
- getTimeout() -
Method in interface org.apache.uima.resource.MessagingSpecifier
- Gets the timeout period in milliseconds.
- getTimeout() -
Method in interface org.apache.uima.resource.URISpecifier
- Gets the timeout period in milliseconds.
- getTimerImpl() -
Method in interface org.apache.uima.collection.metadata.CpeConfiguration
- Removes timer class
- getToolkitsSpecs() -
Method in class org.apache.uima.pear.tools.InstallationDescriptor
-
- getTopType() -
Method in interface org.apache.uima.cas.TypeSystem
- Get the top type, i.e., the root of the type system.
- getTotal() -
Method in interface org.apache.uima.util.Progress
- The total amount being processed, in terms of units specified by
Progress.getUnit().
- getTotal() -
Method in class org.apache.uima.util.ProgressImpl
-
- getTotalTime() -
Method in class org.apache.uima.util.AnalysisEnginePerformanceReports
-
- getTypClass(FeatureStructure) -
Method in interface org.apache.uima.cas.FeaturePath
- Returns the type class of the feature path.
- getType() -
Method in interface org.apache.uima.cas.admin.FSIndexComparator
- Get the type of this comparator.
- getType(FeatureStructure) -
Method in interface org.apache.uima.cas.FeaturePath
- Returns the type of the feature path.
- getType() -
Method in interface org.apache.uima.cas.FeatureStructure
- Get the type of this FS.
- getType() -
Method in interface org.apache.uima.cas.FSIndex
- Return the type of feature structures this index contains.
- getType(String) -
Method in interface org.apache.uima.cas.TypeNameSpace
-
- getType(String) -
Method in interface org.apache.uima.cas.TypeSystem
- Get a type object for a given type name.
- getType() -
Method in interface org.apache.uima.cas_data.FeatureStructure
- Gets the type of this FeatureStructure
- getType(int) -
Method in interface org.apache.uima.jcas.JCas
- get the JCas _Type instance for a particular CAS type constant
- getType(TOP) -
Method in interface org.apache.uima.jcas.JCas
- Deprecated. use instance.jcasType instead - faster
- getType() -
Method in interface org.apache.uima.resource.metadata.ConfigurationParameter
- Retrieves the data type of this configuration parameter.
- getType(String) -
Method in interface org.apache.uima.resource.metadata.TypeSystemDescription
- Retrieves a Type from this TypeSystem fragment.
- getType() -
Method in interface org.apache.uima.util.ProcessTraceEvent
- Gets the type of event.
- getTypeIndexID() -
Method in class org.apache.uima.examples.SourceDocumentInformation
-
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.AnnotationBase
-
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.BooleanArray
- used to obtain reference to the _Type instance
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.ByteArray
- used to obtain reference to the _Type instance
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.DoubleArray
- used to obtain reference to the _Type instance
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.EmptyFloatList
-
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.EmptyFSList
-
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.EmptyIntegerList
-
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.EmptyStringList
-
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.FloatArray
- used to obtain reference to the _Type instance
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.FloatList
-
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.FSArray
- used to obtain reference to the _Type instance
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.FSList
-
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.IntegerArray
- used to obtain reference to the _Type instance
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.IntegerList
-
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.LongArray
- used to obtain reference to the _Type instance
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.NonEmptyFloatList
-
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.NonEmptyFSList
-
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.NonEmptyIntegerList
-
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.NonEmptyStringList
-
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.ShortArray
- used to obtain reference to the _Type instance
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.Sofa
-
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.StringArray
- used to obtain reference to the TOP_Type instance
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.StringList
-
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.TOP
- used to obtain reference to the TOP_Type instance
- getTypeIndexID() -
Method in class org.apache.uima.jcas.cas.TOP_Type
- used to obtain reference to the TOP_Type instance
- getTypeIndexID() -
Method in class org.apache.uima.jcas.tcas.Annotation
-
- getTypeIndexID() -
Method in class org.apache.uima.jcas.tcas.DocumentAnnotation
-
- getTypeIterator() -
Method in interface org.apache.uima.cas.TypeSystem
- Get an iterator over all types, in no particular order.
- getTypeName() -
Method in interface org.apache.uima.resource.metadata.FsIndexDescription
- Gets the Type name for this index.
- getTypeNameSpace(String) -
Method in interface org.apache.uima.cas.TypeSystem
- Create a type name space object for the name parameter.
- getTypePriorities() -
Method in class org.apache.uima.resource.CasDefinition
-
- getTypePriorities() -
Method in interface org.apache.uima.resource.metadata.ProcessingResourceMetaData
- Retrieves the Type Priorites for this Processing Resource.
- getTypes() -
Method in interface org.apache.uima.resource.metadata.TypePriorityList
- Gets the type names, in order of their priority.
- getTypes() -
Method in interface org.apache.uima.resource.metadata.TypeSystemDescription
- Gets descriptions of all Types in this TypeSystem fragment.
- getTypeSystem() -
Method in class org.apache.uima.analysis_engine.annotator.Annotator_ImplBase
- Deprecated. Gets the
TypeSystem that was passed to the most recent call to
Annotator_ImplBase.typeSystemInit(TypeSystem).
- getTypeSystem() -
Method in interface org.apache.uima.analysis_engine.ResultSpecification
- get the type system associated with this result specification.
- getTypeSystem() -
Method in interface org.apache.uima.cas.CAS
- Return the type system of this CAS instance.
- getTypeSystem() -
Method in interface org.apache.uima.jcas.JCas
- Return the type system of this CAS instance.
- getTypeSystem() -
Method in interface org.apache.uima.resource.metadata.ProcessingResourceMetaData
- Retrieves the Type System used by this Processing Resource.
- getTypeSystemDescription() -
Method in class org.apache.uima.resource.CasDefinition
-
- getTypeSystemMgr() -
Method in interface org.apache.uima.cas.admin.CASMgr
- Return a writable version of the type system.
- getUimaContext() -
Method in interface org.apache.uima.resource.Resource
- Gets the UIMA Context for this Resource.
- getUimaContext() -
Method in class org.apache.uima.resource.Resource_ImplBase
-
- getUimaContextAdmin() -
Method in interface org.apache.uima.resource.Resource
- Gets the Administrative interface to the UIMA Context.
- getUimaContextAdmin() -
Method in class org.apache.uima.resource.Resource_ImplBase
- Gets the Admin interface to this Resource's UimaContext.
- getUniqueMBeanName() -
Method in interface org.apache.uima.resource.ManagementObject
- Gets a valid JMX MBean name that is unique among all ManagementObjects in this
JVM.
- getUniqueName() -
Method in interface org.apache.uima.UimaContextAdmin
- Returns a UUID-like unique name of this component.
- getUnit() -
Method in interface org.apache.uima.util.Progress
- The unit type represented by the
Progress.getCompleted() and Progress.getTotal() numbers.
- getUnit() -
Method in class org.apache.uima.util.ProgressImpl
-
- getUri() -
Method in class org.apache.uima.examples.SourceDocumentInformation
- getter for uri - gets URI of document.
- getUri(int) -
Method in class org.apache.uima.examples.SourceDocumentInformation_Type
-
- getUri() -
Method in interface org.apache.uima.resource.DataResource
- Gets the URI of the data.
- getUri() -
Method in interface org.apache.uima.resource.URISpecifier
- Retrieves the URI at which a Resource may be located.
- getUrl() -
Method in interface org.apache.uima.resource.ConfigurableDataResourceSpecifier
- Retrieves the URL of the data.
- getUrl() -
Method in interface org.apache.uima.resource.DataResource
- Gets the URL where the data is stored.
- getURL() -
Method in class org.apache.uima.util.XMLInputSource
- Gets the base for resolving relative paths.
- getUUID() -
Method in interface org.apache.uima.resource.metadata.ResourceMetaData
- Gets the UUID (Universally Unique Identifier) for this Resource.
- getValue() -
Method in interface org.apache.uima.collection.metadata.NameValuePair
- Gets the value.
- getValue() -
Method in interface org.apache.uima.resource.metadata.NameValuePair
- Gets the value.
- getValue() -
Method in interface org.apache.uima.resource.Parameter
- Gets the value of the parameter.
- getValue() -
Method in interface org.apache.uima.search.Attribute
- Gets the value of this attribute.
- getValueAsString(FeatureStructure) -
Method in interface org.apache.uima.cas.FeaturePath
- Returns the feature path value as string for the given FeatureStructure.
- getValueType() -
Method in interface org.apache.uima.cas.FeatureValuePath
- Deprecated. Returns the type that this feature path will evaluate to.
- getVendor() -
Method in interface org.apache.uima.resource.metadata.FsIndexCollection
- Gets the vendor of this FS Index Collection.
- getVendor() -
Method in interface org.apache.uima.resource.metadata.ResourceManagerConfiguration
- Gets the vendor of this Resource Manager Configuration.
- getVendor() -
Method in interface org.apache.uima.resource.metadata.ResourceMetaData
- Gets the vendor of this Resource.
- getVendor() -
Method in interface org.apache.uima.resource.metadata.TypePriorities
- Gets the vendor of this TypePriorities declaration.
- getVendor() -
Method in interface org.apache.uima.resource.metadata.TypeSystemDescription
- Gets the vendor of this Type System.
- getVerificationMsg() -
Method in class org.apache.uima.pear.tools.InstallationController
-
- getVersion() -
Method in interface org.apache.uima.resource.metadata.FsIndexCollection
- Gets the version number of this FS Index Collection.
- getVersion() -
Method in interface org.apache.uima.resource.metadata.ResourceManagerConfiguration
- Gets the version number of this Resource Manager Configuration.
- getVersion() -
Method in interface org.apache.uima.resource.metadata.ResourceMetaData
- Gets the version number of this Resource.
- getVersion() -
Method in interface org.apache.uima.resource.metadata.TypePriorities
- Gets the version number of this TypePriorities declaration.
- getVersion() -
Method in interface org.apache.uima.resource.metadata.TypeSystemDescription
- Gets the version number of this Type System.
- getVersion() -
Static method in class org.apache.uima.uimacpp.CppUimajEngine
-
- getVersionString() -
Static method in class org.apache.uima.UIMAFramework
- Gets the framework implementation's version number as a string.
- getView() -
Method in interface org.apache.uima.cas.AnnotationBaseFS
- Gets the CAS view associated with the Sofa that this Annotation is over.
- getView(String) -
Method in interface org.apache.uima.cas.CAS
- Get the view for a Sofa (subject of analysis).
- getView(SofaFS) -
Method in interface org.apache.uima.cas.CAS
- Get the view for a Sofa (subject of analysis).
- getView() -
Method in class org.apache.uima.jcas.cas.AnnotationBase
-
- getView(int) -
Method in class org.apache.uima.jcas.cas.AnnotationBase_Type
-
- getView(String) -
Method in interface org.apache.uima.jcas.JCas
- Get the view for a Sofa (subject of analysis).
- getView(SofaFS) -
Method in interface org.apache.uima.jcas.JCas
- Get the view for a Sofa (subject of analysis).
- getViewIterator() -
Method in interface org.apache.uima.cas.CAS
- Get iterator over all views in this CAS.
- getViewIterator(String) -
Method in interface org.apache.uima.cas.CAS
- Get iterator over all views with the given name prefix.
- getViewIterator() -
Method in interface org.apache.uima.jcas.JCas
- Get iterator over all views in this JCas.
- getViewIterator(String) -
Method in interface org.apache.uima.jcas.JCas
- Get iterator over all views with the given name prefix.
- getViewName() -
Method in interface org.apache.uima.cas.CAS
- Get the view name.
- getViewName() -
Method in interface org.apache.uima.jcas.JCas
- Get the view name.
- getWaitTimeBetweenRetries() -
Method in interface org.apache.uima.collection.metadata.CasProcessorMaxRestarts
-
- getXCASHandler(CAS) -
Method in class org.apache.uima.cas.impl.XCASDeserializer
- Create a default handler for deserializing an XCAS into the
cas parameter.
- getXCASHandler(CAS, OutOfTypeSystemData) -
Method in class org.apache.uima.cas.impl.XCASDeserializer
- Create a default handler for deserializing an XCAS into the
cas parameter.
- getXmiCasHandler(CAS) -
Method in class org.apache.uima.cas.impl.XmiCasDeserializer
- Create a default handler for deserializing a CAS from XMI.
- getXmiCasHandler(CAS, boolean) -
Method in class org.apache.uima.cas.impl.XmiCasDeserializer
- Create a default handler for deserializing a CAS from XMI.
- getXmiCasHandler(CAS, boolean, XmiSerializationSharedData) -
Method in class org.apache.uima.cas.impl.XmiCasDeserializer
- Create a default handler for deserializing a CAS from XMI.
- getXmiCasHandler(CAS, boolean, XmiSerializationSharedData, int) -
Method in class org.apache.uima.cas.impl.XmiCasDeserializer
- Create a default handler for deserializing a CAS from XMI.
- getXmiCasHandler(CAS, boolean, XmiSerializationSharedData, int, AllowPreexistingFS) -
Method in class org.apache.uima.cas.impl.XmiCasDeserializer
- Create a default handler for deserializing a CAS from XMI.
- getXMLParser() -
Static method in class org.apache.uima.UIMAFramework
- Get a reference to the UIMA
XMLParser, which is used to parse
ResourceSpecifier objects from their XML representations.
- gt(float) -
Method in interface org.apache.uima.cas.FSFloatConstraint
- Require float value to be greater than
f.
- gt(int) -
Method in interface org.apache.uima.cas.FSIntConstraint
- Require int value to be greater than
i.
DataResource.
CollectionReader.
IndexBuildSpecification.CAS get indexed with a UIMA-compliant search engine.UIMAException.STANDARD_MESSAGE_CATALOG.
UIMAException.STANDARD_MESSAGE_CATALOG.
Resource from a ResourceSpecifier.
Annotator_ImplBase.getContext() method.
cpeDescription Applications do not need to call this
method.
Resource from a ResourceSpecifier.
CasData.
CAS.
Hashtable objects that are used to substitute $dlg_comp_id$root
macros in URL and absolute path expressions.
InstallationController class allows installing PEAR files that contain UIMA
compliant components.InstallationController class for a given component
and a given installation root directory.
InstallationController class for a given component
and a given installation root directory.
InstallationController class for a given component
and a given installation root directory.
InstallationController
class for a given component and a given installation root directory.
InstallationMonitor interface defines methods required for notifying of
component installation status and location of the installed PEAR packages.PackageSelector interface defines methods required for manually or
automatically selecting installed PEAR package root directories and PEAR package files.TestStatus class encapsulates attributes related to the results of the
'serviceability' verification test.InstallationDescriptor class encapsulates all elements and parameters included
in the XML Installation Descriptor file.ActionInfo class defines 'installation action' attributes.ArgInfo class defines attributes of a service command argument.ComponentInfo class defines UIMA component attributes.ServiceInfo class defines attributes of a 'service' component.InstallationDescriptorHandler class allows parsing XML installation descriptor
files, creating instances of the InstallationDescriptor class.InstallationProcessor class implements operations specified in the
installation descriptor.InstallationProcessor class, using given main
component root path and a table of installed delegate components.
InstallationController object
as the requestor.
InstallationTester application allows performing simple verification of the
installed UIMA compliant component by using standard UIMA framework interface.InstallationTester class, identifies a specified
component using UIMA API.
InstrumentationFacility interface defines a standard way for UIMA components
to be instrumented for performance evaluation.InternationalizedException class adds internationalization
support to the standard functionality provided by
java.lang.Exception.InternationalizedException with a null
message.
InternationalizedException with the specified
cause and a null message.
InternationalizedException with the specified
message.
InternationalizedException with the specified
message and cause.
InternationalizedRuntimeException class adds internationalization support to
the standard functionality provided by java.lang.RuntimeException.InternationalizedRuntimeException with a null message.
InternationalizedRuntimeException with the specified cause and a
null message.
InternationalizedRuntimeException with the specified message.
InternationalizedRuntimeException with the specified message and
cause.
XMLParser to indicate that an XML document is invalid or does not specify a
valid object of the desired class.UIMAException.STANDARD_MESSAGE_CATALOG.
UIMAException.STANDARD_MESSAGE_CATALOG.
true, if a given text file contains only ASCII characters, otherwise
returns false.
true, if a given input stream contains only ASCII characters, otherwise
returns false.
CollectionReader.
FeatureStructure.getIndexed() instead
MetaDataObject allows the values of its attributes to be
modified.
FeatureStructure that existed prior to the mark
represented by this Markere is modified.
FeatureStructure was created after the mark represented by this Marker object.
UIMAFramework.getDefaultPerformanceTuningProperties().
JCas interface.JCas interface.CAS interface.JCas instances.JCasPool.JCasPool(int, AnalysisEngine) instead.
f.
i.
MetaDataObject.
ResourceManager after this object has been
instantiated.
LocalInstallationAgent allows localizing files of UIMA compliant components
within the single PEAR structure, and verifying localized component's files using UIMA framework
API.LocalInstallationAgent class, using a given main
component root directory.
Logger is a component used to log messages.f.
i.
CAS.getView(String), and the
framework will automatically do the necessary Sofa mappings.
CAS.getView(String), and the
framework will automatically do the necessary Sofa mappings.
CAS that is used to query when FSs were
created or modified with respect to the marker.MessageRouter class facilitates intra-process message routing.MessageRouter class.
StdChannelListener interface declares methods that should be implemented by
each standard message channel listener.Resource.fs.
CAS.NAME_DEFAULT_SOFA, and the value has
changed. In general, user code should not need to refer to this name.
NameClassPair with the specified name and class.
MetaDataObject that stores a name (String) and value (Object).newCas is an instanceof CAS.
newCas is an instanceof JCas.
CollectionProcessingManager instance.
CollectionProcessingManager instance.
ConfigurationManager used by this implementation.
ResourceManager used by this implementation.
ResourceManagerPearWrapper used by this implementation.
AnalysisEngine.newCAS() but wraps the new CAS objects with the Java-object-based
JCas interface.
Logger, which can be passed for example to the
AnalysisEngine.setLogger(Logger) method in order to have separate Analysis Engine
instances used separate loggers.
SaxDeserializer object, which implements the SAX
ContentHandler interface and can be used to deserialize an
XMLizable object from the events sent from a SAX parser.
SaxDeserializer.
UimaTimer, which is used to collect performance
statistics for UIMA components.
UimaContext.
org.apache.uima.pear.tools package provides applications
and tools that allow installing PEAR packages containing UIMA-compliant
components, verifying serviceability of installed components by using
UIMA API and browsing PEAR packages.org.apache.uima.pear.util package provides utilities that
facilitate common operations with general files, strings and XML files,
as well as simple process message routing and other useful operations.Resources and ResourceSpecifiers.PackageBrowser class allows browsing both archived and unarchived PEAR
packages, finding package files and directories, loading installation descriptor files and
returning run-time environment settings required for installed components.PackageCreatorException with the specified message.
PackageCreatorException with the specified message.
PackageCreatorException with the specified message and cause.
PackageCreatorException with the specified message and cause.
PackageInstaller class is the main user API for installing
PEAR packages.PackageInstallerException with the specified message.
PackageInstallerException with the specified message.
PackageInstallerException with the specified message and cause.
PackageInstallerException with the specified message and cause.
PackageSelectorGUI class provides simple Swing-based file dialog windows for
selecting root directories of installed PEAR packages, as well as PEAR package files, which
contain components that need to be installed.PackageDirFilter class allows filtering directories.PackageFileFilter class allows filtering PEAR package files.ConfigurationParameterSettings
object that holds configuration settings that will be used to configure this AnalysisEngine,
overridding any conflicting settings specified in this AnalysisEngine's Descriptor.
ConfigurationParameterSettings object that holds
configuration settings that will be used to configure this Resource, overridding any
conflicting settings specified in this Resource's Descriptor.
AnalysisEngine.process(CAS) that will be supported.
Properties object that
holds settings that tune the performance of the framework.
RelativePathResolver that this DataResource should use to resolve relative resource
URLs.
ResourceManager
that this AnalysisEngine should use.
ResourceManager
that this Resource should use to locate and access other Resources.
AnalysisEngine.PARAM_NUM_SIMULTANEOUS_REQUESTS) to become available to
serve a AnalysisEngine.process(CAS) request.
UimaContext that
is to be used by this Resource to access its external resource and configuration parameters.
XMLParser.parseAnalysisEngineDescription(XMLInputSource) should be used
instead.
XMLParser.parseAnalysisEngineDescription(XMLInputSource,ParsingOptions)
should be used instead.