Class FileSystemCollectionReader

  • All Implemented Interfaces:
    BaseCollectionReader, CollectionReader, ConfigurableResource, Resource

    public class FileSystemCollectionReader
    extends CollectionReader_ImplBase
    A simple collection reader that reads documents from a directory in the filesystem. It can be configured with the following parameters:
    • InputDirectory - path to directory containing files
    • Encoding (optional) - character encoding of the input files
    • Language (optional) - language of the input documents
    • Field Detail

      • PARAM_INPUTDIR

        public static final java.lang.String PARAM_INPUTDIR
        Name of configuration parameter that must be set to the path of a directory containing input files.
        See Also:
        Constant Field Values
      • PARAM_ENCODING

        public static final java.lang.String PARAM_ENCODING
        Name of configuration parameter that contains the character encoding used by the input files. If not specified, the default system encoding will be used.
        See Also:
        Constant Field Values
      • PARAM_LANGUAGE

        public static final java.lang.String PARAM_LANGUAGE
        Name of optional configuration parameter that contains the language of the documents in the input directory. If specified this information will be added to the CAS.
        See Also:
        Constant Field Values
      • PARAM_XCAS

        public static final java.lang.String PARAM_XCAS
        Optional configuration parameter that specifies XCAS input files
        See Also:
        Constant Field Values
      • PARAM_LENIENT

        public static final java.lang.String PARAM_LENIENT
        Name of the configuration parameter that must be set to indicate if the execution proceeds if an encountered type is unknown
        See Also:
        Constant Field Values
      • mFiles

        private java.util.ArrayList mFiles
      • mEncoding

        private java.lang.String mEncoding
      • mLanguage

        private java.lang.String mLanguage
      • mCurrentIndex

        private int mCurrentIndex
      • mTEXT

        private boolean mTEXT
      • mXCAS

        private java.lang.String mXCAS
      • lenient

        private boolean lenient
    • Constructor Detail

      • FileSystemCollectionReader

        public FileSystemCollectionReader()
    • Method Detail

      • hasNext

        public boolean hasNext()
        Description copied from interface: BaseCollectionReader
        Gets whether there are any elements remaining to be read from this CollectionReader.
        Returns:
        true if and only if there are more elements available from this CollectionReader.
        See Also:
        BaseCollectionReader.hasNext()
      • close

        public void close()
                   throws java.io.IOException
        Description copied from interface: BaseCollectionReader
        Closes this CollectionReader, after which it may no longer be used.
        Throws:
        java.io.IOException - if an I/O failure occurs
        See Also:
        BaseCollectionReader.close()
      • getProgress

        public Progress[] getProgress()
        Description copied from interface: BaseCollectionReader
        Gets information about the number of entities and/or amount of data that has been read from this CollectionReader, and the total amount that remains (if that information is available).

        This method returns an array of Progress objects so that results can be reported using different units. For example, the CollectionReader could report progress in terms of the number of documents that have been read and also in terms of the number of bytes that have been read. In many cases, it will be sufficient to return just one Progress object.

        Returns:
        an array of Progress objects. Each object may have different units (for example number of entities or bytes).
        See Also:
        BaseCollectionReader.getProgress()
      • getNumberOfDocuments

        public int getNumberOfDocuments()
        Gets the total number of documents that will be returned by this collection reader. This is not part of the general collection reader interface.
        Returns:
        the number of documents in the collection
      • getDescription

        public static CollectionReaderDescription getDescription()
                                                          throws InvalidXMLException
        Parses and returns the descriptor for this collection reader. The descriptor is stored in the uima.jar file and located using the ClassLoader.
        Returns:
        an object containing all of the information parsed from the descriptor.
        Throws:
        InvalidXMLException - if the descriptor is invalid or missing
      • getDescriptorURL

        public static java.net.URL getDescriptorURL()