Class OperationalProperties_impl
java.lang.Object
org.apache.uima.resource.metadata.impl.MetaDataObject_impl
org.apache.uima.resource.metadata.impl.OperationalProperties_impl
- All Implemented Interfaces:
Serializable,Cloneable,MetaDataObject,OperationalProperties,XMLizable
public class OperationalProperties_impl
extends MetaDataObject_impl
implements OperationalProperties
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
MetaDataObject_impl.MetaDataAttr, MetaDataObject_impl.SerialContext, MetaDataObject_impl.Serializer -
Field Summary
Fields inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
serialContext -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidbuildFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) Initializes this object from its XML DOM representation.booleanGets whether this component will modify the CAS.booleanGets whether this AnalysisEngine may output new CASes.protected XmlizationInfoTo be implemented by subclasses to return information describing how to represent this object in XML.booleanGets whether multiple instances of this component can be run in parallel, each receiving a subset of the documents from a collection.voidsetModifiesCas(boolean aModifiesCas) Sets whether this component will modify the CAS.voidsetMultipleDeploymentAllowed(boolean aMultipleDeploymentAllowed) Sets whether multiple instances of this component can be run in parallel, each receiving a subset of the documents from a collection.voidsetOutputsNewCASes(boolean aOutputsNewCASes) Sets whether this AnalysisEngine may output new CASes.Methods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
buildFromXMLElement, clone, equals, getAdditionalAttributes, getAttributeClass, getAttributeValue, getInfoset, getMatchingNode, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSerialContext, getSourceUrl, getSourceUrlString, getWrapperClass, getXMLAttributes, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, resolveSettings, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXml, writePropertyAsElement
-
Constructor Details
-
OperationalProperties_impl
public OperationalProperties_impl()
-
-
Method Details
-
getModifiesCas
public boolean getModifiesCas()Description copied from interface:OperationalPropertiesGets whether this component will modify the CAS.- Specified by:
getModifiesCasin interfaceOperationalProperties- Returns:
- true if this component modifies the CAS, false if it does not.
-
isMultipleDeploymentAllowed
public boolean isMultipleDeploymentAllowed()Description copied from interface:OperationalPropertiesGets whether multiple instances of this component can be run in parallel, each receiving a subset of the documents from a collection.- Specified by:
isMultipleDeploymentAllowedin interfaceOperationalProperties- Returns:
- true if multiple instances can be run in parallel, false if not
-
setModifiesCas
public void setModifiesCas(boolean aModifiesCas) Description copied from interface:OperationalPropertiesSets whether this component will modify the CAS.- Specified by:
setModifiesCasin interfaceOperationalProperties- Parameters:
aModifiesCas- true if this component modifies the CAS, false if it does not.
-
setMultipleDeploymentAllowed
public void setMultipleDeploymentAllowed(boolean aMultipleDeploymentAllowed) Description copied from interface:OperationalPropertiesSets whether multiple instances of this component can be run in parallel, each receiving a subset of the documents from a collection.- Specified by:
setMultipleDeploymentAllowedin interfaceOperationalProperties- Parameters:
aMultipleDeploymentAllowed- true if multiple instances can be run in parallel, false if not
-
getOutputsNewCASes
public boolean getOutputsNewCASes()Description copied from interface:OperationalPropertiesGets whether this AnalysisEngine may output new CASes. If this property is set to true, an application can use theAnalysisEngine.processAndOutputNewCASes(CAS)to pass a CAS to this this AnalysisEngine and then step through all of the output CASes that it produces. For example, such an AnalysisEngine could segment a CAS into smaller pieces, emitting each as a separate CAS.- Specified by:
getOutputsNewCASesin interfaceOperationalProperties- Returns:
- true if this component may output new CASes, false if it does not
-
setOutputsNewCASes
public void setOutputsNewCASes(boolean aOutputsNewCASes) Description copied from interface:OperationalPropertiesSets whether this AnalysisEngine may output new CASes. If this property is set to true, an application can use theAnalysisEngine.processAndOutputNewCASes(CAS)to pass a CAS to this this AnalysisEngine and then step through all of the output CASes that it produces. For example, such an AnalysisEngine could segment a CAS into smaller pieces, emitting each as a separate CAS.- Specified by:
setOutputsNewCASesin interfaceOperationalProperties- Parameters:
aOutputsNewCASes- true if this component may output new CASes, false if it does not
-
getXmlizationInfo
Description copied from class:MetaDataObject_implTo be implemented by subclasses to return information describing how to represent this object in XML.- Specified by:
getXmlizationInfoin classMetaDataObject_impl- Returns:
- information defining this object's XML representation
-
buildFromXMLElement
public void buildFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) throws InvalidXMLException Description copied from class:MetaDataObject_implInitializes this object from its XML DOM representation. This method is typically called from theXMLParser. It is overridden by specific Java impl classes to provide additional defaulting (e.g. see AnalysisEngineDescription_impl)- Specified by:
buildFromXMLElementin interfaceXMLizable- Overrides:
buildFromXMLElementin classMetaDataObject_impl- Parameters:
aElement- the XML element that represents this object.aParser- a reference to the UIMAXMLParser. TheXMLParser.buildObject(Element)method can be used to construct sub-objects.aOptions- option settings- Throws:
InvalidXMLException- if the input XML element does not specify a valid object
-