public final class AnalysisEngineFactory extends Object
AnalysisEngineDescriptions
and AnalysisEngines
.Modifier and Type | Method and Description |
---|---|
static AnalysisEngine |
createAggregate(AnalysisEngineDescription desc)
Deprecated.
|
static AnalysisEngine |
createAggregate(List<AnalysisEngineDescription> analysisEngineDescriptions,
List<String> componentNames,
TypePriorities typePriorities,
SofaMapping[] sofaMappings)
Deprecated.
|
static AnalysisEngine |
createAggregate(List<AnalysisEngineDescription> analysisEngineDescriptions,
List<String> componentNames,
TypePriorities typePriorities,
SofaMapping[] sofaMappings,
FlowControllerDescription flowControllerDescription)
|
static AnalysisEngine |
createAggregate(List<Class<? extends AnalysisComponent>> componentClasses,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
SofaMapping[] sofaMappings,
FlowControllerDescription flowControllerDescription,
Object... configurationData)
|
static AnalysisEngine |
createAggregate(List<Class<? extends AnalysisComponent>> componentClasses,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
SofaMapping[] sofaMappings,
Object... configurationData)
|
static AnalysisEngineDescription |
createAggregateDescription(AnalysisEngineDescription... analysisEngineDescriptions)
Deprecated.
|
static AnalysisEngineDescription |
createAggregateDescription(FlowControllerDescription flowControllerDescription,
AnalysisEngineDescription... analysisEngineDescriptions)
|
static AnalysisEngineDescription |
createAggregateDescription(List<AnalysisEngineDescription> analysisEngineDescriptions,
List<String> componentNames,
TypePriorities typePriorities,
SofaMapping[] sofaMappings,
FlowControllerDescription flowControllerDescription)
|
static AnalysisEngineDescription |
createAggregateDescription(List<Class<? extends AnalysisComponent>> componentClasses,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
SofaMapping[] sofaMappings,
FlowControllerDescription flowControllerDescription,
Object... configurationData)
|
static AnalysisEngineDescription |
createAggregateDescription(List<Class<? extends AnalysisComponent>> componentClasses,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
SofaMapping[] sofaMappings,
Object... configurationData)
|
static AnalysisEngine |
createAnalysisEngine(AnalysisEngineDescription analysisEngineDescription,
String viewName)
Deprecated.
|
static AnalysisEngine |
createAnalysisEngine(String descriptorName,
Object... configurationData)
Deprecated.
|
static AnalysisEngineDescription |
createAnalysisEngineDescription(String descriptorName,
Object... configurationData)
Deprecated.
|
static AnalysisEngineDescription |
createAnalysisEngineDescriptionFromPath(String descriptorPath,
Object... configurationData)
Deprecated.
|
static AnalysisEngine |
createAnalysisEngineFromPath(String descriptorPath,
Object... configurationData)
Deprecated.
|
static AnalysisEngine |
createEngine(AnalysisEngineDescription desc,
Object... configurationData)
Create and configure a primitive
AnalysisEngine . |
static AnalysisEngine |
createEngine(AnalysisEngineDescription analysisEngineDescription,
String viewName)
This method provides a convenient way to instantiate an AnalysisEngine where the default view
is mapped to the view name passed into the method.
|
static AnalysisEngine |
createEngine(Class<? extends AnalysisComponent> componentClass,
Object... configurationData)
Create and configure a primitive
AnalysisEngine . |
static AnalysisEngine |
createEngine(Class<? extends AnalysisComponent> componentClass,
TypeSystemDescription typeSystem,
Object... configurationData)
Create and configure a primitive
AnalysisEngine . |
static AnalysisEngine |
createEngine(Class<? extends AnalysisComponent> componentClass,
TypeSystemDescription typeSystem,
String[] typePriorities,
Object... configurationData)
Create and configure a primitive
AnalysisEngine . |
static AnalysisEngine |
createEngine(Class<? extends AnalysisComponent> componentClass,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
Object... configurationData)
Create and configure a primitive
AnalysisEngine . |
static AnalysisEngine |
createEngine(List<AnalysisEngineDescription> analysisEngineDescriptions,
List<String> componentNames,
TypePriorities typePriorities,
SofaMapping[] sofaMappings)
Create and configure an aggregate
AnalysisEngine from several component descriptions. |
static AnalysisEngine |
createEngine(List<AnalysisEngineDescription> analysisEngineDescriptions,
List<String> componentNames,
TypePriorities typePriorities,
SofaMapping[] sofaMappings,
FlowControllerDescription flowControllerDescription)
Create and configure an aggregate
AnalysisEngine from several component descriptions. |
static AnalysisEngine |
createEngine(List<Class<? extends AnalysisComponent>> componentClasses,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
SofaMapping[] sofaMappings,
FlowControllerDescription flowControllerDescription,
Object... configurationData)
Create and configure an aggregate
AnalysisEngine from several component classes. |
static AnalysisEngine |
createEngine(List<Class<? extends AnalysisComponent>> componentClasses,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
SofaMapping[] sofaMappings,
Object... configurationData)
Create and configure an aggregate
AnalysisEngine from several component classes. |
static AnalysisEngine |
createEngine(String descriptorName,
Object... configurationData)
Get an AnalysisEngine from the name (Java-style, dotted) of an XML descriptor file, and a set
of configuration parameters.
|
static AnalysisEngineDescription |
createEngineDescription(AnalysisEngineDescription... analysisEngineDescriptions)
Create and configure an aggregate
AnalysisEngine from several component descriptions. |
static AnalysisEngineDescription |
createEngineDescription(Class<? extends AnalysisComponent> componentClass,
Object... configurationData)
Create and configure a primitive
AnalysisEngine . |
static AnalysisEngineDescription |
createEngineDescription(Class<? extends AnalysisComponent> componentClass,
TypeSystemDescription typeSystem,
Object... configurationData)
Create and configure a primitive
AnalysisEngine . |
static AnalysisEngineDescription |
createEngineDescription(Class<? extends AnalysisComponent> componentClass,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
FsIndexCollection indexes,
Capability[] capabilities,
ConfigurationParameter[] configurationParameters,
Object[] configurationValues)
Create and configure a primitive
AnalysisEngine . |
static AnalysisEngineDescription |
createEngineDescription(Class<? extends AnalysisComponent> componentClass,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
FsIndexCollection indexes,
Capability[] capabilities,
ConfigurationParameter[] configurationParameters,
Object[] configurationValues,
Map<String,ExternalResourceDescription> externalResources)
Create and configure a primitive
AnalysisEngine . |
static AnalysisEngineDescription |
createEngineDescription(Class<? extends AnalysisComponent> componentClass,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
FsIndexCollection indexes,
Capability[] capabilities,
Object... configurationData)
Create and configure a primitive
AnalysisEngine . |
static AnalysisEngineDescription |
createEngineDescription(Class<? extends AnalysisComponent> componentClass,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
Object... configurationData)
Create and configure a primitive
AnalysisEngine . |
static AnalysisEngineDescription |
createEngineDescription(FlowControllerDescription flowControllerDescription,
AnalysisEngineDescription... analysisEngineDescriptions)
A simplified factory method for creating an aggregate description for a given flow controller
and a sequence of analysis engine descriptions
|
static AnalysisEngineDescription |
createEngineDescription(List<AnalysisEngineDescription> analysisEngineDescriptions,
List<String> componentNames,
TypePriorities typePriorities,
SofaMapping[] sofaMappings,
FlowControllerDescription flowControllerDescription)
A factory method for creating an aggregate description.
|
static AnalysisEngineDescription |
createEngineDescription(List<Class<? extends AnalysisComponent>> componentClasses,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
SofaMapping[] sofaMappings,
FlowControllerDescription flowControllerDescription,
Object... configurationData)
Create and configure an aggregate
AnalysisEngine from several component classes. |
static AnalysisEngineDescription |
createEngineDescription(List<Class<? extends AnalysisComponent>> componentClasses,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
SofaMapping[] sofaMappings,
Object... configurationData)
Create and configure an aggregate
AnalysisEngine from several component classes. |
static AnalysisEngineDescription |
createEngineDescription(String descriptorName,
Object... configurationData)
Provides a way to create an AnalysisEngineDescription using a descriptor file referenced by
name
|
static AnalysisEngineDescription |
createEngineDescriptionFromPath(String descriptorPath,
Object... configurationData)
Get an
AnalysisEngineDescription from an XML descriptor file and a set of configuration
parameters. |
static AnalysisEngine |
createEngineFromPath(String descriptorPath,
Object... configurationData)
Get an
AnalysisEngine from an XML descriptor file and a set of configuration
parameters. |
static AnalysisEngine |
createPrimitive(AnalysisEngineDescription desc,
Object... configurationData)
Deprecated.
|
static AnalysisEngine |
createPrimitive(Class<? extends AnalysisComponent> componentClass,
Object... configurationData)
Deprecated.
|
static AnalysisEngine |
createPrimitive(Class<? extends AnalysisComponent> componentClass,
TypeSystemDescription typeSystem,
Object... configurationData)
Deprecated.
|
static AnalysisEngine |
createPrimitive(Class<? extends AnalysisComponent> componentClass,
TypeSystemDescription typeSystem,
String[] typePriorities,
Object... configurationData)
Deprecated.
|
static AnalysisEngine |
createPrimitive(Class<? extends AnalysisComponent> componentClass,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
Object... configurationData)
|
static AnalysisEngineDescription |
createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass,
Object... configurationData)
Deprecated.
|
static AnalysisEngineDescription |
createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass,
TypeSystemDescription typeSystem,
Object... configurationData)
Deprecated.
|
static AnalysisEngineDescription |
createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
FsIndexCollection indexes,
Capability[] capabilities,
ConfigurationParameter[] configurationParameters,
Object[] configurationValues)
|
static AnalysisEngineDescription |
createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
FsIndexCollection indexes,
Capability[] capabilities,
ConfigurationParameter[] configurationParameters,
Object[] configurationValues,
Map<String,ExternalResourceDescription> externalResources)
|
static AnalysisEngineDescription |
createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
FsIndexCollection indexes,
Capability[] capabilities,
Object... configurationData)
|
static AnalysisEngineDescription |
createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass,
TypeSystemDescription typeSystem,
TypePriorities typePriorities,
Object... configurationData)
|
public static AnalysisEngine createEngine(String descriptorName, Object... configurationData) throws InvalidXMLException, IOException, ResourceInitializationException
descriptorName
- The fully qualified, Java-style, dotted name of the XML descriptor file.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.AnalysisEngine
created from the XML descriptor and the configuration
parameters.IOException
- if an I/O error occursInvalidXMLException
- if the input XML is not valid or does not specify a valid ResourceSpecifier
ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngine createAnalysisEngine(String descriptorName, Object... configurationData) throws InvalidXMLException, IOException, ResourceInitializationException
createEngine(String, Object...)
descriptorName
- The fully qualified, Java-style, dotted name of the XML descriptor file.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.AnalysisEngine
created from the XML descriptor and the configuration
parameters.IOException
- if an I/O error occursInvalidXMLException
- if the input XML is not valid or does not specify a valid ResourceSpecifier
ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngine createEngine(AnalysisEngineDescription analysisEngineDescription, String viewName) throws ResourceInitializationException
analysisEngineDescription
- the analysis engine description from which the engine is instantiatedviewName
- the view name to map the default view toResourceInitializationException
- if a failure occurred during production of the resource.AggregateBuilder
@Deprecated public static AnalysisEngine createAnalysisEngine(AnalysisEngineDescription analysisEngineDescription, String viewName) throws ResourceInitializationException
createEngine(AnalysisEngineDescription, String)
analysisEngineDescription
- the analysis engine description from which the engine is instantiatedviewName
- the view name to map the default view toResourceInitializationException
- if a failure occurred during production of the resource.AggregateBuilder
public static AnalysisEngine createEngine(AnalysisEngineDescription desc, Object... configurationData) throws ResourceInitializationException
AnalysisEngine
.desc
- the descriptor to create the analysis engine from.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.AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngine createAggregate(AnalysisEngineDescription desc) throws ResourceInitializationException
createEngine(AnalysisEngineDescription, Object...)
AnalysisEngine
.desc
- the descriptor to create the analysis engine from.AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngine createPrimitive(AnalysisEngineDescription desc, Object... configurationData) throws ResourceInitializationException
createEngine(AnalysisEngineDescription, Object...)
AnalysisEngine
.desc
- the descriptor to create the analysis engine from.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.AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngine createEngine(Class<? extends AnalysisComponent> componentClass, Object... configurationData) throws ResourceInitializationException
AnalysisEngine
. The type system is detected
automatically using TypeSystemDescriptionFactory.createTypeSystemDescription()
. Type
priorities are detected automatically using
TypePrioritiesFactory.createTypePriorities()
. Indexes are detected automatically using
FsIndexFactory.createFsIndexCollection()
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
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.AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngine createPrimitive(Class<? extends AnalysisComponent> componentClass, Object... configurationData) throws ResourceInitializationException
createEngine(Class, Object...)
AnalysisEngine
. The type system is detected
automatically using TypeSystemDescriptionFactory.createTypeSystemDescription()
. Type
priorities are detected automatically using
TypePrioritiesFactory.createTypePriorities()
. Indexes are detected automatically using
FsIndexFactory.createFsIndexCollection()
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
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.AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngine createEngine(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, Object... configurationData) throws ResourceInitializationException
AnalysisEngine
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).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.AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngine createPrimitive(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, Object... configurationData) throws ResourceInitializationException
createEngine(Class, TypeSystemDescription, Object...)
AnalysisEngine
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).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.AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngine createEngine(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, String[] typePriorities, Object... configurationData) throws ResourceInitializationException
AnalysisEngine
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities as an array of type names (may be null).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.AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngine createPrimitive(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, String[] typePriorities, Object... configurationData) throws ResourceInitializationException
createEngine(Class, TypeSystemDescription, String[], Object...)
AnalysisEngine
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities as an array of type names (may be null).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.AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngine createEngine(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, Object... configurationData) throws ResourceInitializationException
AnalysisEngine
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).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.AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngine createPrimitive(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, Object... configurationData) throws ResourceInitializationException
AnalysisEngine
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).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.AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngine createEngine(List<Class<? extends AnalysisComponent>> componentClasses, TypeSystemDescription typeSystem, TypePriorities typePriorities, SofaMapping[] sofaMappings, Object... configurationData) throws ResourceInitializationException
AnalysisEngine
from several component classes.componentClasses
- a list of class that extend AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).sofaMappings
- The SofA mappings (may be null).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.AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngine createAggregate(List<Class<? extends AnalysisComponent>> componentClasses, TypeSystemDescription typeSystem, TypePriorities typePriorities, SofaMapping[] sofaMappings, Object... configurationData) throws ResourceInitializationException
AnalysisEngine
from several component classes.componentClasses
- a list of class that extend AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).sofaMappings
- The SofA mappings (may be null).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.AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngine createEngine(List<Class<? extends AnalysisComponent>> componentClasses, TypeSystemDescription typeSystem, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription, Object... configurationData) throws ResourceInitializationException
AnalysisEngine
from several component classes.componentClasses
- a list of class that extend AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).sofaMappings
- The SofA mappings (may be null).flowControllerDescription
- the flow controller description to be used by this aggregate (may be null).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.AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngine createAggregate(List<Class<? extends AnalysisComponent>> componentClasses, TypeSystemDescription typeSystem, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription, Object... configurationData) throws ResourceInitializationException
createEngine(List, TypeSystemDescription, TypePriorities, SofaMapping[], FlowControllerDescription, Object...)
AnalysisEngine
from several component classes.componentClasses
- a list of class that extend AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).sofaMappings
- The SofA mappings (may be null).flowControllerDescription
- the flow controller description to be used by this aggregate (may be null).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.AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngine createEngine(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings) throws ResourceInitializationException
AnalysisEngine
from several component descriptions.analysisEngineDescriptions
- a list of analysis engine descriptions from which the aggregate engine is instantiatedcomponentNames
- a list of names for the analysis engines in the aggregate. There must be exactly one
name for each analysis engine, given in the same order as the descriptions.typePriorities
- The type priorities (may be null).sofaMappings
- The SofA mappings (may be null).AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngine createAggregate(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings) throws ResourceInitializationException
createEngine(List, List, TypePriorities, SofaMapping[])
AnalysisEngine
from several component descriptions.analysisEngineDescriptions
- a list of analysis engine descriptions from which the aggregate engine is instantiatedcomponentNames
- a list of names for the analysis engines in the aggregate. There must be exactly one
name for each analysis engine, given in the same order as the descriptions.typePriorities
- The type priorities (may be null).sofaMappings
- The SofA mappings (may be null).AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngine createEngine(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription) throws ResourceInitializationException
AnalysisEngine
from several component descriptions.analysisEngineDescriptions
- a list of analysis engine descriptions from which the aggregate engine is instantiatedcomponentNames
- a list of names for the analysis engines in the aggregate. There must be exactly one
name for each analysis engine, given in the same order as the descriptions.typePriorities
- The type priorities (may be null).sofaMappings
- The SofA mappings (may be null).flowControllerDescription
- the flow controller description to be used by this aggregate (may be null).AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngine createAggregate(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription) throws ResourceInitializationException
AnalysisEngine
from several component descriptions.analysisEngineDescriptions
- a list of analysis engine descriptions from which the aggregate engine is instantiatedcomponentNames
- a list of names for the analysis engines in the aggregate. There must be exactly one
name for each analysis engine, given in the same order as the descriptions.typePriorities
- The type priorities (may be null).sofaMappings
- The SofA mappings (may be null).flowControllerDescription
- the flow controller description to be used by this aggregate (may be null).AnalysisEngine
created from the specified component class and initialized
with the configuration parameters.ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngine createEngineFromPath(String descriptorPath, Object... configurationData) throws InvalidXMLException, IOException, ResourceInitializationException
AnalysisEngine
from an XML descriptor file and a set of configuration
parameters.descriptorPath
- The path to the XML descriptor file.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.AnalysisEngine
created from the XML descriptor and the configuration
parameters.IOException
- if an I/O error occursInvalidXMLException
- if the input XML is not valid or does not specify a valid ResourceSpecifier
ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngine createAnalysisEngineFromPath(String descriptorPath, Object... configurationData) throws InvalidXMLException, IOException, ResourceInitializationException
createEngineFromPath(String, Object...)
AnalysisEngine
from an XML descriptor file and a set of configuration
parameters.descriptorPath
- The path to the XML descriptor file.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.AnalysisEngine
created from the XML descriptor and the configuration
parameters.IOException
- if an I/O error occursInvalidXMLException
- if the input XML is not valid or does not specify a valid ResourceSpecifier
ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngineDescription createEngineDescriptionFromPath(String descriptorPath, Object... configurationData) throws InvalidXMLException, IOException
AnalysisEngineDescription
from an XML descriptor file and a set of configuration
parameters.descriptorPath
- The path to the XML descriptor file.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.AnalysisEngineDescription
created from the XML descriptor and the
configuration parameters.IOException
- if an I/O error occursInvalidXMLException
- if the input XML is not valid or does not specify a valid ResourceSpecifier
@Deprecated public static AnalysisEngineDescription createAnalysisEngineDescriptionFromPath(String descriptorPath, Object... configurationData) throws InvalidXMLException, IOException
createEngineDescriptionFromPath(String, Object...)
AnalysisEngineDescription
from an XML descriptor file and a set of configuration
parameters.descriptorPath
- The path to the XML descriptor file.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.AnalysisEngineDescription
created from the XML descriptor and the
configuration parameters.IOException
- if an I/O error occursInvalidXMLException
- if the input XML is not valid or does not specify a valid ResourceSpecifier
public static AnalysisEngineDescription createEngineDescription(String descriptorName, Object... configurationData) throws InvalidXMLException, IOException
descriptorName
- The fully qualified, Java-style, dotted name of the XML descriptor file.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. Will override
configuration parameter settings in the descriptor fileIOException
- if an I/O error occursInvalidXMLException
- if the input XML is not valid or does not specify a valid ResourceSpecifier
@Deprecated public static AnalysisEngineDescription createAnalysisEngineDescription(String descriptorName, Object... configurationData) throws InvalidXMLException, IOException
createEngineDescription(String, Object...)
descriptorName
- The fully qualified, Java-style, dotted name of the XML descriptor file.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. Will override
configuration parameter settings in the descriptor fileIOException
- if an I/O error occursInvalidXMLException
- if the input XML is not valid or does not specify a valid ResourceSpecifier
public static AnalysisEngineDescription createEngineDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, Object... configurationData) throws ResourceInitializationException
AnalysisEngine
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).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.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngineDescription createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, Object... configurationData) throws ResourceInitializationException
createEngineDescription(Class, TypeSystemDescription, Object...)
AnalysisEngine
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).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.ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngineDescription createEngineDescription(Class<? extends AnalysisComponent> componentClass, Object... configurationData) throws ResourceInitializationException
AnalysisEngine
. The type system is detected
automatically using TypeSystemDescriptionFactory.createTypeSystemDescription()
. Type
priorities are detected automatically using
TypePrioritiesFactory.createTypePriorities()
. Indexes are detected automatically using
FsIndexFactory.createFsIndexCollection()
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
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.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngineDescription createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass, Object... configurationData) throws ResourceInitializationException
createEngineDescription(Class, Object...)
AnalysisEngine
. The type system is detected
automatically using TypeSystemDescriptionFactory.createTypeSystemDescription()
. Type
priorities are detected automatically using
TypePrioritiesFactory.createTypePriorities()
. Indexes are detected automatically using
FsIndexFactory.createFsIndexCollection()
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
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.ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngineDescription createEngineDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, Object... configurationData) throws ResourceInitializationException
AnalysisEngine
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).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.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngineDescription createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, Object... configurationData) throws ResourceInitializationException
AnalysisEngine
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).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.ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngineDescription createEngineDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, Object... configurationData) throws ResourceInitializationException
AnalysisEngine
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).indexes
- the Feature Structure Index collection used by this analysis engine to iterate over
annotations in the CAS
. If this is not null explicitly,
any indexes declared via FsIndexCollection
in
the class are ignored.capabilities
- the operations the component can perform in terms of consumed and produced types, sofa
names, and languages. If this is set explicitly here, any capabilities declared via
SofaCapability
or TypeCapability
in the class are ignored.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. In addition to
parameter names, external resource keys can also be specified. The value has to be an
ExternalResourceDescription
in that case.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngineDescription createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, Object... configurationData) throws ResourceInitializationException
createEngineDescription(Class, TypeSystemDescription, TypePriorities, FsIndexCollection, Capability[], Object...)
AnalysisEngine
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).indexes
- the Feature Structure Index collection used by this analysis engine to iterate over
annotations in the CAS
. If this is not null explicitly,
any indexes declared via FsIndexCollection
in
the class are ignored.capabilities
- the operations the component can perform in terms of consumed and produced types, sofa
names, and languages. If this is set explicitly here, any capabilities declared via
SofaCapability
or TypeCapability
in the class are ignored.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. In addition to
parameter names, external resource keys can also be specified. The value has to be an
ExternalResourceDescription
in that case.ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngineDescription createEngineDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, ConfigurationParameter[] configurationParameters, Object[] configurationValues) throws ResourceInitializationException
AnalysisEngine
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).indexes
- the Feature Structure Index collection used by this analysis engine to iterate over
annotations in the CAS
. If this is not null explicitly,
any indexes declared via FsIndexCollection
in
the class are ignored.capabilities
- the operations the component can perform in terms of consumed and produced types, sofa
names, and languages. If this is set explicitly here, any capabilities declared via
SofaCapability
or TypeCapability
in the class are ignored.configurationParameters
- the configuration parameter declarations.configurationValues
- the configuration parameter values.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngineDescription createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, ConfigurationParameter[] configurationParameters, Object[] configurationValues) throws ResourceInitializationException
createEngineDescription(Class, TypeSystemDescription, TypePriorities, FsIndexCollection, Capability[], ConfigurationParameter[], Object[])
AnalysisEngine
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).indexes
- the Feature Structure Index collection used by this analysis engine to iterate over
annotations in the CAS
. If this is not null explicitly,
any indexes declared via FsIndexCollection
in
the class are ignored.capabilities
- the operations the component can perform in terms of consumed and produced types, sofa
names, and languages. If this is set explicitly here, any capabilities declared via
SofaCapability
or TypeCapability
in the class are ignored.configurationParameters
- the configuration parameter declarations.configurationValues
- the configuration parameter values.ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngineDescription createEngineDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, ConfigurationParameter[] configurationParameters, Object[] configurationValues, Map<String,ExternalResourceDescription> externalResources) throws ResourceInitializationException
AnalysisEngine
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).indexes
- the Feature Structure Index collection used by this analysis engine to iterate over
annotations in the CAS
. If this is set explicitly here,
any indexes declared via FsIndexCollection
in
the class are ignored.capabilities
- the operations the component can perform in terms of consumed and produced types, sofa
names, and languages. If this is set explicitly here, any capabilities declared via
SofaCapability
or TypeCapability
in the class are ignored.configurationParameters
- the configuration parameter declarations.configurationValues
- the configuration parameter values.externalResources
- external resources to bind to the analysis engine. (may be null)ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngineDescription createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, ConfigurationParameter[] configurationParameters, Object[] configurationValues, Map<String,ExternalResourceDescription> externalResources) throws ResourceInitializationException
createEngineDescription(Class, TypeSystemDescription, TypePriorities, FsIndexCollection, Capability[], ConfigurationParameter[], Object[], Map)
AnalysisEngine
.componentClass
- a class that extends AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).indexes
- the Feature Structure Index collection used by this analysis engine to iterate over
annotations in the CAS
. If this is set explicitly here,
any indexes declared via FsIndexCollection
in
the class are ignored.capabilities
- the operations the component can perform in terms of consumed and produced types, sofa
names, and languages. If this is set explicitly here, any capabilities declared via
SofaCapability
or TypeCapability
in the class are ignored.configurationParameters
- the configuration parameter declarations.configurationValues
- the configuration parameter values.externalResources
- external resources to bind to the analysis engine. (may be null)ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngineDescription createEngineDescription(List<Class<? extends AnalysisComponent>> componentClasses, TypeSystemDescription typeSystem, TypePriorities typePriorities, SofaMapping[] sofaMappings, Object... configurationData) throws ResourceInitializationException
AnalysisEngine
from several component classes.componentClasses
- a list of class that extend AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).sofaMappings
- The SofA mappings (may be null).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.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngineDescription createAggregateDescription(List<Class<? extends AnalysisComponent>> componentClasses, TypeSystemDescription typeSystem, TypePriorities typePriorities, SofaMapping[] sofaMappings, Object... configurationData) throws ResourceInitializationException
createEngineDescription(List, TypeSystemDescription, TypePriorities, SofaMapping[], Object...)
AnalysisEngine
from several component classes.componentClasses
- a list of class that extend AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).sofaMappings
- The SofA mappings (may be null).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.ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngineDescription createEngineDescription(AnalysisEngineDescription... analysisEngineDescriptions) throws ResourceInitializationException
AnalysisEngine
from several component descriptions.analysisEngineDescriptions
- a list of analysis engine descriptions from which the aggregate engine is instantiatedResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngineDescription createAggregateDescription(AnalysisEngineDescription... analysisEngineDescriptions) throws ResourceInitializationException
createEngineDescription(AnalysisEngineDescription...)
AnalysisEngine
from several component descriptions.analysisEngineDescriptions
- a list of analysis engine descriptions from which the aggregate engine is instantiatedResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngineDescription createEngineDescription(List<Class<? extends AnalysisComponent>> componentClasses, TypeSystemDescription typeSystem, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription, Object... configurationData) throws ResourceInitializationException
AnalysisEngine
from several component classes.componentClasses
- a list of class that extend AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).sofaMappings
- The SofA mappings (may be null).flowControllerDescription
- the flow controller description to be used by this aggregate (may be null).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.ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngineDescription createAggregateDescription(List<Class<? extends AnalysisComponent>> componentClasses, TypeSystemDescription typeSystem, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription, Object... configurationData) throws ResourceInitializationException
createEngineDescription(List, TypeSystemDescription, TypePriorities, SofaMapping[], FlowControllerDescription, Object...)
AnalysisEngine
from several component classes.componentClasses
- a list of class that extend AnalysisComponent
e.g. via
JCasAnnotator_ImplBase
typeSystem
- A description of the types (may be null).typePriorities
- The type priorities (may be null).sofaMappings
- The SofA mappings (may be null).flowControllerDescription
- the flow controller description to be used by this aggregate (may be null).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.ResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngineDescription createEngineDescription(FlowControllerDescription flowControllerDescription, AnalysisEngineDescription... analysisEngineDescriptions) throws ResourceInitializationException
flowControllerDescription
- the flow controller description to be used by this aggregate (may be null).analysisEngineDescriptions
- a list of analysis engine descriptions from which the aggregate engine is instantiatedResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngineDescription createAggregateDescription(FlowControllerDescription flowControllerDescription, AnalysisEngineDescription... analysisEngineDescriptions) throws ResourceInitializationException
flowControllerDescription
- the flow controller description to be used by this aggregate (may be null).analysisEngineDescriptions
- a list of analysis engine descriptions from which the aggregate engine is instantiatedResourceInitializationException
- if a failure occurred during production of the resource.public static AnalysisEngineDescription createEngineDescription(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription) throws ResourceInitializationException
analysisEngineDescriptions
- list of analysis engine descriptions.componentNames
- list of component names - must be one name per description!typePriorities
- The type priorities (may be null).sofaMappings
- The SofA mappings (may be null).flowControllerDescription
- the flow controller description to be used by this aggregate (may be null).ResourceInitializationException
- if a failure occurred during production of the resource.@Deprecated public static AnalysisEngineDescription createAggregateDescription(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription) throws ResourceInitializationException
analysisEngineDescriptions
- list of analysis engine descriptions.componentNames
- list of component names - must be one name per description!typePriorities
- The type priorities (may be null).sofaMappings
- The SofA mappings (may be null).flowControllerDescription
- the flow controller description to be used by this aggregate (may be null).ResourceInitializationException
- if a failure occurred during production of the resource.Copyright © 2012–2017 The Apache Software Foundation. All rights reserved.