Package org.apache.uima.resource.metadata.impl

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
public class FsIndexCollection_impl extends MetaDataObject_impl implements FsIndexCollection
See Also:

  • Constructor Details

    • FsIndexCollection_impl

      public FsIndexCollection_impl()

  • Method Details

    • getName

      public String getName()
      Specified by:
      getName in interface FsIndexCollection
      Returns:
      the name of this FS Index Collection, null if none has been specified.

    • setName

      public void setName(String aName)
      Description copied from interface: FsIndexCollection
      Sets the name of this FS Index Collection.
      Specified by:
      setName in interface FsIndexCollection
      Parameters:
      aName - the name of this FS Index Collection

    • getVersion

      public String getVersion()
      Specified by:
      getVersion in interface FsIndexCollection
      Returns:
      the version number of this FS Index Collection, as a String, null if none has been specified.

    • setVersion

      public void setVersion(String aVersion)
      Description copied from interface: FsIndexCollection
      Sets the version number of this FS Index Collection.
      Specified by:
      setVersion in interface FsIndexCollection
      Parameters:
      aVersion - the version number of this FS Index Collection, as a String

    • getDescription

      public String getDescription()
      Description copied from interface: FsIndexCollection
      Gets the description of this FS Index Collection.
      Specified by:
      getDescription in interface FsIndexCollection
      Returns:
      the description of this FS Index Collection, null if none has been specified.

    • setDescription

      public void setDescription(String aDescription)
      Description copied from interface: FsIndexCollection
      Sets the description of this FS Index Collection.
      Specified by:
      setDescription in interface FsIndexCollection
      Parameters:
      aDescription - the description of this FS Index Collection

    • getVendor

      public String getVendor()
      Description copied from interface: FsIndexCollection
      Gets the vendor of this FS Index Collection.
      Specified by:
      getVendor in interface FsIndexCollection
      Returns:
      the vendor of this FS Index Collection, as a String

    • setVendor

      public void setVendor(String aVendor)
      Description copied from interface: FsIndexCollection
      Sets the vendor of this FS Index Collection.
      Specified by:
      setVendor in interface FsIndexCollection
      Parameters:
      aVendor - the vendor of this FS Index Collection, as a String, null if none has been specified.

    • getImports

      public Import[] getImports()
      Description copied from interface: FsIndexCollection
      Gets the imports declared by this FS Index Collection.
      Specified by:
      getImports in interface FsIndexCollection
      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 interface FsIndexCollection
      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 the CAS.
      Specified by:
      getFsIndexes in interface FsIndexCollection
      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 the CAS.
      Specified by:
      setFsIndexes in interface FsIndexCollection
      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 interface FsIndexCollection
      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 interface FsIndexCollection
      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's fsIndexes 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 interface FsIndexCollection
      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's fsIndexes 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 interface FsIndexCollection
      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 the ResourceManager.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: FsIndexCollection
      Resolves any import declarations in this FS Index Collection, adding the imported FsIndexDescriptions directly onto this FsIndexCollection's fsIndexes 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 interface FsIndexCollection
      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 the ResourceManager.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 class MetaDataObject_impl
      Returns:
      information defining this object's XML representation