org.apache.uima.collection

## Interface CollectionReaderDescription

- All Superinterfaces:
    Cloneable, MetaDataObject, ResourceCreationSpecifier, ResourceSpecifier, Serializable, XMLizable
  All Known Implementing Classes:
    CollectionReaderDescription_impl

      public interface CollectionReaderDescription
      extends ResourceCreationSpecifier

  An `CollectionReaderDescription` contains all of the information needed to instantiate and use an `CollectionReader`.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `ProcessingResourceMetaData` | `getCollectionReaderMetaData()` Retrieves the metadata that describes the CollectionReader.

    - ### Methods inherited from interface org.apache.uima.resource.ResourceCreationSpecifier

      `doFullValidation, doFullValidation, getExternalResourceDependencies, getExternalResourceDependency, getFrameworkImplementation, getImplementationName, getMetaData, getResourceManagerConfiguration, setExternalResourceDependencies, setFrameworkImplementation, setImplementationName, setMetaData, setResourceManagerConfiguration, validate, validate`

    - ### 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`

- - ### Method Detail

    - #### getCollectionReaderMetaData

          ProcessingResourceMetaData getCollectionReaderMetaData()

      Retrieves the metadata that describes the CollectionReader.
      Returns:
        the `ResourceMetaData` object containing the CollectionReader's metadata. This object can be modified.

Copyright © 2006–2021 The Apache Software Foundation. All rights reserved.