org.apache.uima.collection.impl.metadata.cpe
Class CpeComponentDescriptorImpl

java.lang.Object
  extended by org.apache.uima.resource.metadata.impl.MetaDataObject_impl
      extended by org.apache.uima.collection.impl.metadata.cpe.CpeComponentDescriptorImpl
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, CpeComponentDescriptor, MetaDataObject, XMLizable

public class CpeComponentDescriptorImpl
extends MetaDataObject_impl
implements CpeComponentDescriptor

See Also:
Serialized Form

Constructor Summary
CpeComponentDescriptorImpl()
           
 
Method Summary
 java.net.URL findAbsoluteUrl(ResourceManager aResourceManager)
          Returns the absolute URL where the component descriptor is located.
 Import getImport()
          Gets the Import object that declares where the component descriptor is located.
 CpeInclude getInclude()
          Returns component's descriptor file path
protected  XmlizationInfo getXmlizationInfo()
          To be implemented by subclasses to return information describing how to represent this object in XML.
 void setImport(Import aImport)
          Sets the Import object that declares where the component descriptor is located.
 void setInclude(CpeInclude aInclude)
          Sets component's descriptor file path
 
Methods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
buildFromXMLElement, buildFromXMLElement, clone, equals, getAttributeClass, getAttributeValue, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSourceUrl, getSourceUrlString, getWrapperClass, getXMLAttributes, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, setAttributeValue, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, writeArrayPropertyAsElement, writeMapPropertyToXml, writePropertyAsElement
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl
 
Methods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
 

Constructor Detail

CpeComponentDescriptorImpl

public CpeComponentDescriptorImpl()
Method Detail

setInclude

public void setInclude(CpeInclude aInclude)
Description copied from interface: CpeComponentDescriptor
Sets component's descriptor file path

Specified by:
setInclude in interface CpeComponentDescriptor
Parameters:
aInclude - - CpeInclude containing file path

getInclude

public CpeInclude getInclude()
Description copied from interface: CpeComponentDescriptor
Returns component's descriptor file path

Specified by:
getInclude in interface CpeComponentDescriptor
Returns:
CpeInclude

getImport

public Import getImport()
Description copied from interface: CpeComponentDescriptor
Gets the Import object that declares where the component descriptor is located. Import objects support locating the component descriptor either using a path that's relative to the CPE descriptor's location ("import by location") or using the classpath/datapath ("import by name").

Specified by:
getImport in interface CpeComponentDescriptor
Returns:
the import, null if none

setImport

public void setImport(Import aImport)
Description copied from interface: CpeComponentDescriptor
Sets the Import object that declares where the component descriptor is located. Import objects support locating the component descriptor either using a path that's relative to the CPE descriptor's location ("import by location") or using the classpath/datapath ("import by name").

Specified by:
setImport in interface CpeComponentDescriptor
Parameters:
aImport - the import, null if none

findAbsoluteUrl

public java.net.URL findAbsoluteUrl(ResourceManager aResourceManager)
                             throws ResourceConfigurationException
Description copied from interface: CpeComponentDescriptor
Returns the absolute URL where the component descriptor is located. This will use either the include or import property, whichever is specified.

Specified by:
findAbsoluteUrl in interface CpeComponentDescriptor
Parameters:
aResourceManager - resource manager to use to do import-by-name lookups
Returns:
the absolute URL of the component descriptor
Throws:
ResourceConfigurationException
See Also:
CpeComponentDescriptor.findAbsoluteUrl(ResourceManager)

getXmlizationInfo

protected XmlizationInfo getXmlizationInfo()
Description copied from class: MetaDataObject_impl
To be implemented by subclasses to return information describing how to represent this object in XML.

Specified by:
getXmlizationInfo in class MetaDataObject_impl
Returns:
information defining this object's XML representation


Copyright © 2011. All Rights Reserved.