Package org.apache.uima.collection
Interface CasInitializer
-
- All Superinterfaces:
ConfigurableResource
,Resource
- All Known Implementing Classes:
CasInitializer_ImplBase
@Deprecated public interface CasInitializer extends ConfigurableResource
Deprecated.As of v2.0, CAS Initializers are deprecated. A component that performs an operation like HTML detagging should instead be implemented as a "multi-Sofa" annotator. See org.apache.uima.examples.XmlDetagger for an example.A component that takes an Object and initializes aCAS
.CAS Initializers may be used by some
CollectionReader
implementations.
-
-
Field Summary
-
Fields inherited from interface org.apache.uima.resource.Resource
PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description ProcessingResourceMetaData
getProcessingResourceMetaData()
Deprecated.Gets the metadata that describes thisCasInitializer
.void
initializeCas(Object aObj, CAS aCAS)
Deprecated.Reads content and metadata from an Object and initializes aCAS
.void
typeSystemInit(TypeSystem aTypeSystem)
Deprecated.Informs this CasInitializer that the CAS TypeSystem has changed.-
Methods inherited from interface org.apache.uima.resource.ConfigurableResource
getConfigParameterValue, getConfigParameterValue, reconfigure, setConfigParameterValue, setConfigParameterValue
-
Methods inherited from interface org.apache.uima.resource.Resource
destroy, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, initialize, setLogger
-
-
-
-
Method Detail
-
typeSystemInit
void typeSystemInit(TypeSystem aTypeSystem) throws ResourceInitializationException
Deprecated.Informs this CasInitializer that the CAS TypeSystem has changed. The CollectionReader must call this method whenever the CollectionReader's typeSystemInit() method is called.In this method, the CasInitializer should use the
TypeSystem
to resolve the names of Type and Features to the actualType
andFeature
objects, which can then be used during processing.- Parameters:
aTypeSystem
- the type system to use- Throws:
ResourceInitializationException
- if the type system is not compatible with this CAS Initializer
-
initializeCas
void initializeCas(Object aObj, CAS aCAS) throws CollectionException, IOException
Deprecated.Reads content and metadata from an Object and initializes aCAS
.- Parameters:
aObj
- the object to processaCAS
- the CAS to populate- Throws:
CollectionException
- if an error occurs during initialization of the CASIOException
- if an I/O failure occurs
-
getProcessingResourceMetaData
ProcessingResourceMetaData getProcessingResourceMetaData()
Deprecated.Gets the metadata that describes thisCasInitializer
.- Returns:
- an object containing all metadata for this CasInitializer
-
-