Interface CollectionReader

    • Method Detail

      • getNext

        void getNext​(CAS aCAS)
              throws java.io.IOException,
                     CollectionException
        Gets the next element of the collection. The element will be stored in the provided CAS object. If this is a consuming CollectionReader (see BaseCollectionReader.isConsuming()), this element will also be removed from the collection.
        Parameters:
        aCAS - the CAS to populate with the next element of the collection
        Throws:
        UIMA_IllegalStateException - if there are no more elements left in the collection
        java.io.IOException - if an I/O failure occurs
        CollectionException - if there is some other problem with reading from the Collection
      • getCasInitializer

        @Deprecated
        CasInitializer getCasInitializer()
        Deprecated.
        As of v2.0 CAS Initializers are deprecated.
        Gets the CAS Initializer that has been assigned to this Collection Reader. Note that CollectionReader implementations are not required to make use of the CAS Initializer - refer to the documentation for your specific Collection Reader.
        Returns:
        the CAS Initializer for this Collection Reader
      • setCasInitializer

        @Deprecated
        void setCasInitializer​(CasInitializer aCasInitializer)
        Deprecated.
        As of v2.0 CAS Initializers are deprecated.
        Assigns a CAS Initializer for this Collection Reader to use. Note that CollectionReader implementations are not required to make use of the CAS Initializer - refer to the documentation for your specific Collection Reader.
        Parameters:
        aCasInitializer - the CAS Initializer for this Collection Reader