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:
Serializable,Cloneable,FsIndexCollection,MetaDataObject,XMLizable
- 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 TypeMethodDescriptionvoidaddFsIndex(FsIndexDescription aFsIndexDescription) Adds an FS Index description to this collection.Gets the description of this FS Index Collection.Retrieves the FS Index descriptions that are part of this collection.Import[]Gets the imports declared by this FS Index Collection.getName()Gets the name of this FS Index Collection.Gets the vendor of this FS Index Collection.Gets the version number of this FS Index Collection.protected XmlizationInfoTo be implemented by subclasses to return information describing how to represent this object in XML.voidremoveFsIndex(FsIndexDescription aFsIndexDescription) Removes an FS Index description from this collection.voidResolves any import declarations in this FS Index Collection, adding the imported FsIndexDescriptions directly onto this FsIndexCollection'sfsIndexeslist.voidresolveImports(Collection<String> aAlreadyImportedFsIndexURLs, ResourceManager aResourceManager) Deprecated.voidresolveImports(ResourceManager aResourceManager) Resolves any import declarations in this FS Index Collection, adding the imported FsIndexDescriptions directly onto this FsIndexCollection'sfsIndexeslist.voidsetDescription(String aDescription) Sets the description of this FS Index Collection.voidsetFsIndexes(FsIndexDescription[] aFSIndexes) Retrieves the FS Index descriptions that are part of this collection.voidsetImports(Import[] aImports) Sets the imports declared by this FS Index Collection.voidSets the name of this FS Index Collection.voidSets the vendor of this FS Index Collection.voidsetVersion(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, 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
-
FsIndexCollection_impl
public FsIndexCollection_impl()
-
-
Method Details
-
getName
Description copied from interface:FsIndexCollectionGets the name of this FS Index Collection.- Specified by:
getNamein interfaceFsIndexCollection- Returns:
- the name of this FS Index Collection, null if none has been specified.
- See Also:
-
setName
Description copied from interface:FsIndexCollectionSets the name of this FS Index Collection.- Specified by:
setNamein interfaceFsIndexCollection- Parameters:
aName- the name of this FS Index Collection- See Also:
-
getVersion
Description copied from interface:FsIndexCollectionGets the version number of this FS Index Collection.- Specified by:
getVersionin interfaceFsIndexCollection- Returns:
- the version number of this FS Index Collection, as a String, null if none has been specified.
- See Also:
-
setVersion
Description copied from interface:FsIndexCollectionSets the version number of this FS Index Collection.- Specified by:
setVersionin interfaceFsIndexCollection- Parameters:
aVersion- the version number of this FS Index Collection, as a String- See Also:
-
getDescription
Description copied from interface:FsIndexCollectionGets the description of this FS Index Collection.- Specified by:
getDescriptionin interfaceFsIndexCollection- Returns:
- the description of this FS Index Collection, null if none has been specified.
- See Also:
-
setDescription
Description copied from interface:FsIndexCollectionSets the description of this FS Index Collection.- Specified by:
setDescriptionin interfaceFsIndexCollection- Parameters:
aDescription- the description of this FS Index Collection- See Also:
-
getVendor
Description copied from interface:FsIndexCollectionGets the vendor of this FS Index Collection.- Specified by:
getVendorin interfaceFsIndexCollection- Returns:
- the vendor of this FS Index Collection, as a String
- See Also:
-
setVendor
Description copied from interface:FsIndexCollectionSets the vendor of this FS Index Collection.- Specified by:
setVendorin interfaceFsIndexCollection- Parameters:
aVendor- the vendor of this FS Index Collection, as a String, null if none has been specified.- See Also:
-
getImports
Description copied from interface:FsIndexCollectionGets the imports declared by this FS Index Collection.- Specified by:
getImportsin interfaceFsIndexCollection- Returns:
- an array of imports declared by this FS Index Collection.
-
setImports
Description copied from interface:FsIndexCollectionSets the imports declared by this FS Index Collection.- Specified by:
setImportsin interfaceFsIndexCollection- Parameters:
aImports- an array of imports declared by this FS Index Collection.
-
getFsIndexes
Description copied from interface:FsIndexCollectionRetrieves 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:
getFsIndexesin interfaceFsIndexCollection- Returns:
- a description of the FS Indexes that comprise this FS Index Collection
-
setFsIndexes
Description copied from interface:FsIndexCollectionRetrieves 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:
setFsIndexesin interfaceFsIndexCollection- Parameters:
aFSIndexes- a description of the FS Indexes that comprise this FS Index Collection
-
addFsIndex
Description copied from interface:FsIndexCollectionAdds an FS Index description to this collection.- Specified by:
addFsIndexin interfaceFsIndexCollection- Parameters:
aFsIndexDescription- the FS Index description to add
-
removeFsIndex
Description copied from interface:FsIndexCollectionRemoves an FS Index description from this collection.- Specified by:
removeFsIndexin interfaceFsIndexCollection- Parameters:
aFsIndexDescription- the FS Index description to remove (must be == with an FsIndexDescription in this collection, or this method will do nothing).
-
resolveImports
Description copied from interface:FsIndexCollectionResolves any import declarations in this FS Index Collection, adding the imported FsIndexDescriptions directly onto this FsIndexCollection'sfsIndexeslist. 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:
resolveImportsin interfaceFsIndexCollection- Throws:
InvalidXMLException- if either the import target does not exist or is invalid
-
resolveImports
Description copied from interface:FsIndexCollectionResolves any import declarations in this FS Index Collection, adding the imported FsIndexDescriptions directly onto this FsIndexCollection'sfsIndexeslist. 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:
resolveImportsin 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(Collection<String> aAlreadyImportedFsIndexURLs, ResourceManager aResourceManager) throws InvalidXMLException Deprecated.Description copied from interface:FsIndexCollectionResolves any import declarations in this FS Index Collection, adding the imported FsIndexDescriptions directly onto this FsIndexCollection'sfsIndexeslist. 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:
resolveImportsin 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
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
-