Class FsIndexCollection_impl
- java.lang.Object
-
- org.apache.uima.resource.metadata.impl.MetaDataObject_impl
-
- org.apache.uima.resource.metadata.impl.FsIndexCollection_impl
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,FsIndexCollection
,MetaDataObject
,XMLizable
public class FsIndexCollection_impl extends MetaDataObject_impl implements FsIndexCollection
- See Also:
- Serialized Form
-
-
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 Modifier and Type Field Description private static FsIndexDescription[]
EMPTY_FS_INDEX_DESCRIPTION_ARRAY
private java.lang.String
mDescription
private FsIndexDescription[]
mFsIndexes
private Import[]
mImports
private java.lang.String
mName
private java.lang.String
mVendor
private java.lang.String
mVersion
private static long
serialVersionUID
private static XmlizationInfo
XMLIZATION_INFO
-
Fields inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
serialContext
-
-
Constructor Summary
Constructors Constructor Description FsIndexCollection_impl()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addFsIndex(FsIndexDescription aFsIndexDescription)
Adds an FS Index description to this collection.java.lang.String
getDescription()
Gets the description of this FS Index Collection.FsIndexDescription[]
getFsIndexes()
Retrieves the FS Index descriptions that are part of this collection.Import[]
getImports()
Gets the imports declared by this FS Index Collection.java.lang.String
getName()
Gets the name of this FS Index Collection.java.lang.String
getVendor()
Gets the vendor of this FS Index Collection.java.lang.String
getVersion()
Gets the version number of this FS Index Collection.protected XmlizationInfo
getXmlizationInfo()
To be implemented by subclasses to return information describing how to represent this object in XML.void
removeFsIndex(FsIndexDescription aFsIndexDescription)
Removes an FS Index description from this collection.void
resolveImports()
Resolves any import declarations in this FS Index Collection, adding the imported FsIndexDescriptions directly onto this FsIndexCollection'sfsIndexes
list.void
resolveImports(java.util.Collection<java.lang.String> aAlreadyImportedFsIndexURLs, ResourceManager aResourceManager)
Deprecated.void
resolveImports(ResourceManager aResourceManager)
Resolves any import declarations in this FS Index Collection, adding the imported FsIndexDescriptions directly onto this FsIndexCollection'sfsIndexes
list.void
setDescription(java.lang.String aDescription)
Sets the description of this FS Index Collection.void
setFsIndexes(FsIndexDescription[] aFSIndexes)
Retrieves the FS Index descriptions that are part of this collection.void
setImports(Import[] aImports)
Sets the imports declared by this FS Index Collection.void
setName(java.lang.String aName)
Sets the name of this FS Index Collection.void
setVendor(java.lang.String aVendor)
Sets the vendor of this FS Index Collection.void
setVersion(java.lang.String aVersion)
Sets the version number of this FS Index Collection.-
Methods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
buildFromXMLElement, buildFromXMLElement, clone, equals, getAdditionalAttributes, getAttributeClass, getAttributes, getAttributeValue, getInfoset, getMatchingNode, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSerialContext, getSourceUrl, getSourceUrlString, getUnfilteredAttributes, getWrapperClass, getXMLAttributes, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, resolveSettings, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, 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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
EMPTY_FS_INDEX_DESCRIPTION_ARRAY
private static final FsIndexDescription[] EMPTY_FS_INDEX_DESCRIPTION_ARRAY
-
mName
private java.lang.String mName
-
mVersion
private java.lang.String mVersion
-
mDescription
private java.lang.String mDescription
-
mVendor
private java.lang.String mVendor
-
mImports
private Import[] mImports
-
mFsIndexes
private FsIndexDescription[] mFsIndexes
-
XMLIZATION_INFO
private static final XmlizationInfo XMLIZATION_INFO
-
-
Method Detail
-
getName
public java.lang.String getName()
Description copied from interface:FsIndexCollection
Gets the name of this FS Index Collection.- Specified by:
getName
in interfaceFsIndexCollection
- Returns:
- the name of this FS Index Collection, null if none has been specified.
- See Also:
ResourceMetaData.getName()
-
setName
public void setName(java.lang.String aName)
Description copied from interface:FsIndexCollection
Sets the name of this FS Index Collection.- Specified by:
setName
in interfaceFsIndexCollection
- Parameters:
aName
- the name of this FS Index Collection- See Also:
ResourceMetaData.setName(String)
-
getVersion
public java.lang.String getVersion()
Description copied from interface:FsIndexCollection
Gets the version number of this FS Index Collection.- Specified by:
getVersion
in interfaceFsIndexCollection
- Returns:
- the version number of this FS Index Collection, as a String, null if none has been specified.
- See Also:
ResourceMetaData.getVersion()
-
setVersion
public void setVersion(java.lang.String aVersion)
Description copied from interface:FsIndexCollection
Sets the version number of this FS Index Collection.- Specified by:
setVersion
in interfaceFsIndexCollection
- Parameters:
aVersion
- the version number of this FS Index Collection, as a String- See Also:
ResourceMetaData.setVersion(String)
-
getDescription
public java.lang.String getDescription()
Description copied from interface:FsIndexCollection
Gets the description of this FS Index Collection.- Specified by:
getDescription
in interfaceFsIndexCollection
- Returns:
- the description of this FS Index Collection, null if none has been specified.
- See Also:
ResourceMetaData.getDescription()
-
setDescription
public void setDescription(java.lang.String aDescription)
Description copied from interface:FsIndexCollection
Sets the description of this FS Index Collection.- Specified by:
setDescription
in interfaceFsIndexCollection
- Parameters:
aDescription
- the description of this FS Index Collection- See Also:
ResourceMetaData.setDescription(String)
-
getVendor
public java.lang.String getVendor()
Description copied from interface:FsIndexCollection
Gets the vendor of this FS Index Collection.- Specified by:
getVendor
in interfaceFsIndexCollection
- Returns:
- the vendor of this FS Index Collection, as a String
- See Also:
ResourceMetaData.getVendor()
-
setVendor
public void setVendor(java.lang.String aVendor)
Description copied from interface:FsIndexCollection
Sets the vendor of this FS Index Collection.- Specified by:
setVendor
in interfaceFsIndexCollection
- Parameters:
aVendor
- the vendor of this FS Index Collection, as a String, null if none has been specified.- See Also:
ResourceMetaData.setVendor(String)
-
getImports
public Import[] getImports()
Description copied from interface:FsIndexCollection
Gets the imports declared by this FS Index Collection.- Specified by:
getImports
in interfaceFsIndexCollection
- Returns:
- an array of imports declared by this FS Index Collection.
-
setImports
public void setImports(Import[] aImports)
Description copied from interface:FsIndexCollection
Sets the imports declared by this FS Index Collection.- Specified by:
setImports
in interfaceFsIndexCollection
- Parameters:
aImports
- an array of imports declared by this FS Index Collection.
-
getFsIndexes
public FsIndexDescription[] getFsIndexes()
Description copied from interface:FsIndexCollection
Retrieves the FS Index descriptions that are part of this collection. These define the indexes that are used to iterate over annotations in theCAS
.- Specified by:
getFsIndexes
in interfaceFsIndexCollection
- Returns:
- a description of the FS Indexes that comprise this FS Index Collection
-
setFsIndexes
public void setFsIndexes(FsIndexDescription[] aFSIndexes)
Description copied from interface:FsIndexCollection
Retrieves the FS Index descriptions that are part of this collection. These define the indexes that are used to iterate over annotations in theCAS
.- Specified by:
setFsIndexes
in interfaceFsIndexCollection
- Parameters:
aFSIndexes
- a description of the FS Indexes that comprise this FS Index Collection
-
addFsIndex
public void addFsIndex(FsIndexDescription aFsIndexDescription)
Description copied from interface:FsIndexCollection
Adds an FS Index description to this collection.- Specified by:
addFsIndex
in interfaceFsIndexCollection
- Parameters:
aFsIndexDescription
- the FS Index description to add
-
removeFsIndex
public void removeFsIndex(FsIndexDescription aFsIndexDescription)
Description copied from interface:FsIndexCollection
Removes an FS Index description from this collection.- Specified by:
removeFsIndex
in interfaceFsIndexCollection
- Parameters:
aFsIndexDescription
- the FS Index description to remove (must be == with an FsIndexDescription in this collection, or this method will do nothing).
-
resolveImports
public void resolveImports() throws InvalidXMLException
Description copied from interface:FsIndexCollection
Resolves any import declarations in this FS Index Collection, adding the imported FsIndexDescriptions directly onto this FsIndexCollection'sfsIndexes
list. The import elements are then deleted, so this results in a structure that is equivalent to the imported elements having been defined locally.- Specified by:
resolveImports
in interfaceFsIndexCollection
- Throws:
InvalidXMLException
- if either the import target does not exist or is invalid
-
resolveImports
public void resolveImports(ResourceManager aResourceManager) throws InvalidXMLException
Description copied from interface:FsIndexCollection
Resolves any import declarations in this FS Index Collection, adding the imported FsIndexDescriptions directly onto this FsIndexCollection'sfsIndexes
list. The import elements are then deleted, so this results in a structure that is equivalent to the imported elements having been defined locally.- Specified by:
resolveImports
in interfaceFsIndexCollection
- Parameters:
aResourceManager
- the Resource Manager used to locate FS Index Collections imported by name. For example, the path in which to locate these FS Index Collections can be set via theResourceManager.setDataPath(String)
method.- Throws:
InvalidXMLException
- if either the import target does not exist or is invalid
-
resolveImports
@Deprecated public void resolveImports(java.util.Collection<java.lang.String> aAlreadyImportedFsIndexURLs, ResourceManager aResourceManager) throws InvalidXMLException
Deprecated.Description copied from interface:FsIndexCollection
Resolves any import declarations in this FS Index Collection, adding the imported FsIndexDescriptions directly onto this FsIndexCollection'sfsIndexes
list. The import elements are then deleted, so this results in a structure that is equivalent to the imported elements having been defined locally.This version is used internally to resolve nested imports.
- Specified by:
resolveImports
in interfaceFsIndexCollection
- Parameters:
aAlreadyImportedFsIndexURLs
- URLs of already imported FS Index Collections, so we don't import them again.aResourceManager
- the Resource Manager used to locate FS Index Collections imported by name. For example, the path in which to locate these FS Index Collections can be set via theResourceManager.setDataPath(String)
method.- Throws:
InvalidXMLException
- if either the import target does not exist or is invalid
-
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 classMetaDataObject_impl
- Returns:
- information defining this object's XML representation
-
-