Package org.apache.uima.resource.impl
Class ExternalResourceDependency_impl
java.lang.Object
org.apache.uima.resource.metadata.impl.MetaDataObject_impl
org.apache.uima.resource.impl.ExternalResourceDependency_impl
- All Implemented Interfaces:
Serializable,Cloneable,ExternalResourceDependency,MetaDataObject,XMLizable
public class ExternalResourceDependency_impl
extends MetaDataObject_impl
implements ExternalResourceDependency
Reference implementation of
ExternalResourceDependency.- 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 TypeMethodDescriptionRetrieves the textual description of the resource.Retrieves the name of the Java interface through which this resource will be accessed.getKey()Retrieves the key by which the resource is identified.protected XmlizationInfoTo be implemented by subclasses to return information describing how to represent this object in XML.booleanGets whether this resource dependency is optional.voidsetDescription(String aDescription) Retrieves the textual description of the resource.voidsetInterfaceName(String aName) Sets the name of the Java interface through which this resource will be accessed.voidSets the key by which the resource is identified.voidsetOptional(boolean aOptional) Sets whether this resource dependency is optional.Methods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
buildFromXMLElement, 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, writePropertyAsElementMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlMethods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
Constructor Details
-
ExternalResourceDependency_impl
public ExternalResourceDependency_impl()
-
-
Method Details
-
getKey
Description copied from interface:ExternalResourceDependencyRetrieves the key by which the resource is identified.- Specified by:
getKeyin interfaceExternalResourceDependency- Returns:
- the key for this resource.
- See Also:
-
getInterfaceName
Description copied from interface:ExternalResourceDependencyRetrieves the name of the Java interface through which this resource will be accessed.- Specified by:
getInterfaceNamein interfaceExternalResourceDependency- Returns:
- the name of the Java interface for this external resource,
nullif none. - See Also:
-
setKey
Description copied from interface:ExternalResourceDependencySets the key by which the resource is identified.- Specified by:
setKeyin interfaceExternalResourceDependency- Parameters:
aKey- the key for this resource.- See Also:
-
setInterfaceName
Description copied from interface:ExternalResourceDependencySets the name of the Java interface through which this resource will be accessed.- Specified by:
setInterfaceNamein interfaceExternalResourceDependency- Parameters:
aName- the name of the Java interface for this external resource,nullif none.- See Also:
-
getDescription
Description copied from interface:ExternalResourceDependencyRetrieves the textual description of the resource.- Specified by:
getDescriptionin interfaceExternalResourceDependency- Returns:
- the textual description of the resource.
- See Also:
-
isOptional
public boolean isOptional()Description copied from interface:ExternalResourceDependencyGets whether this resource dependency is optional. Dependencies that are not optional must be linked to resource definitions prior to instantiating the Analysis Engine, or an exception will be thrown.- Specified by:
isOptionalin interfaceExternalResourceDependency- Returns:
- true if this resource dependency is optional, false if not
- See Also:
-
setDescription
Description copied from interface:ExternalResourceDependencyRetrieves the textual description of the resource.- Specified by:
setDescriptionin interfaceExternalResourceDependency- Parameters:
aDescription- the textual description of the resource.- See Also:
-
setOptional
public void setOptional(boolean aOptional) Description copied from interface:ExternalResourceDependencySets whether this resource dependency is optional. Dependencies that are not optional must be linked to resource definitions prior to instantiating the Analysis Engine, or an exception will be thrown.- Specified by:
setOptionalin interfaceExternalResourceDependency- Parameters:
aOptional- true if this resource dependency is optional, false if not- See Also:
-
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
-