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

Class FsIndexCollection_impl

    • Constructor Detail

      • FsIndexCollection_impl

        public FsIndexCollection_impl()

    • Method Detail

      • 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

      • 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

        public void resolveImports​(java.util.Collection<java.lang.String> aAlreadyImportedFsIndexURLs,
                           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.

        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