Package de.julielab.jcore.pipeline.builder.base.main

Class Description

java.lang.Object

de.julielab.jcore.pipeline.builder.base.main.Description

All Implemented Interfaces:

Serializable, Cloneable

public class Description
extends Object
implements Serializable, Cloneable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Description()	Required for JSON deserialization and tests.
Description(URL sourceUrl)

Method Summary

Modifier and Type	Method	Description
void	addCapability(String type, String value)
Description	clone()
boolean	equals(Object o)
List<String>	getCapabilities(String type)	Returns the input or output capabilities as specified in the underlying UIMA descriptor of this description.
PipelineBuilderConstants.JcoreMeta.Category	getCategory()
Map<String,org.apache.uima.resource.metadata.ConfigurationParameter>	getConfigurationParameters()
Object	getConfigurationParameterValue(String parameter)
org.apache.uima.resource.metadata.MetaDataObject	getDescriptor()
org.apache.uima.analysis_engine.AnalysisEngineDescription	getDescriptorAsAnalysisEngineDescription()
org.apache.uima.collection.CollectionReaderDescription	getDescriptorAsCollectionReaderDescription()
org.apache.uima.flow.FlowControllerDescription	getDescriptorAsFlowControllerDescriptor()
String	getDescriptorType()
List<String>	getInputCapabilities()
String	getLocation()
MetaDescription	getMetaDescription()
String	getName()
List<String>	getOutputCapabilities()
String	getUimaDescPath()	This field is set when the owning JCoReUIMAPipeline is stored.
URI	getUri()
String	getXmlName()
int	hashCode()
boolean	isActive()	Returns whether this component is active.
void	setActive(boolean active)
void	setCapabilities(String type, List<String> values)
void	setCategory(PipelineBuilderConstants.JcoreMeta.Category category)
void	setConfigurationParameterValue(String key, Object value)
void	setDescriptor(org.apache.uima.resource.metadata.MetaDataObject descriptor)
void	setLocation(String location)
void	setMetaDescription(MetaDescription metaDescription)
void	setName(String name)
void	setUimaDescPath(String uimaDescPath)
void	setUri(URI uri)
void	setXmlName(String xmlName)
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Description

public Description()

Required for JSON deserialization and tests.

Description

public Description(URL sourceUrl)
            throws URISyntaxException,
                   IOException,
                   org.apache.uima.util.InvalidXMLException

Throws:

URISyntaxException

IOException

org.apache.uima.util.InvalidXMLException

Method Detail

isActive

public boolean isActive()

Returns whether this component is active. Non-active components are not stored in the pipeline desc/ directory and also not included in the CPE.xml.

Returns:

true, if this component is active, false otherwise.

setActive

public void setActive(boolean active)

Parameters:

active -

See Also:

isActive

getUimaDescPath

public String getUimaDescPath()

This field is set when the owning JCoReUIMAPipeline is stored. The value of this field is the path to the UIMA descriptor associated with this Description relative to the pipeline desc/ directory. It may be null if the descriptor is not stored by itself but rather in an AAE.

Returns:

The path to the UIMA descriptor, relative to desc/.

setUimaDescPath

public void setUimaDescPath(String uimaDescPath)

getUri

public URI getUri()

Returns:

The URI of the original UIMA descriptor within a JAR.

setUri

public void setUri(URI uri)

getLocation

public String getLocation()

Returns:

The value of the 'location' property in the component.meta file of the component. This is the classpath resource address of the component UIMA descriptor.

setLocation

public void setLocation(String location)

getCategory

public PipelineBuilderConstants.JcoreMeta.Category getCategory()

setCategory

public void setCategory(PipelineBuilderConstants.JcoreMeta.Category category)

getDescriptorType

public String getDescriptorType()

getXmlName

public String getXmlName()

setXmlName

public void setXmlName(String xmlName)

addCapability

public void addCapability(String type,
                          String value)

setCapabilities

public void setCapabilities(String type,
                            List<String> values)

getCapabilities

public List<String> getCapabilities(String type)

Returns the input or output capabilities as specified in the underlying UIMA descriptor of this description.

Parameters:

type - The type of capabilities to return, i.e. PipelineBuilderConstants.Descriptor.CAPABILITIES_IN or PipelineBuilderConstants.Descriptor.CAPABILITIES_OUT-

Returns:

The requested UIMA type capabilities.

getInputCapabilities

public List<String> getInputCapabilities()

getOutputCapabilities

public List<String> getOutputCapabilities()

getName

public String getName()

setName

public void setName(String name)

getConfigurationParameters

public Map<String,org.apache.uima.resource.metadata.ConfigurationParameter> getConfigurationParameters()

getConfigurationParameterValue

public Object getConfigurationParameterValue(String parameter)

setConfigurationParameterValue

public void setConfigurationParameterValue(String key,
                                           Object value)

getDescriptor

public org.apache.uima.resource.metadata.MetaDataObject getDescriptor()

setDescriptor

public void setDescriptor(org.apache.uima.resource.metadata.MetaDataObject descriptor)

getDescriptorAsCollectionReaderDescription

public org.apache.uima.collection.CollectionReaderDescription getDescriptorAsCollectionReaderDescription()

getDescriptorAsAnalysisEngineDescription

public org.apache.uima.analysis_engine.AnalysisEngineDescription getDescriptorAsAnalysisEngineDescription()

getDescriptorAsFlowControllerDescriptor

public org.apache.uima.flow.FlowControllerDescription getDescriptorAsFlowControllerDescriptor()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getMetaDescription

public MetaDescription getMetaDescription()

setMetaDescription

public void setMetaDescription(MetaDescription metaDescription)

toString

public String toString()

Overrides:

toString in class Object

clone

public Description clone()
                  throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException