Interface CasDataCollectionReader

    • Method Detail

      • getNext

        CasData[] getNext​(int aNumToGet)
                   throws IOException,
                          CollectionException
        Gets multiple CasData objects from this CasDataCollectionReader. If this is a consuming Collection Reader (see BaseCollectionReader.isConsuming()), these entities will also be removed from the collection.
        Parameters:
        aNumToGet - the number of CasData objects to get
        Returns:
        an array containing the CasData objects. The length of this array will be at most aNumToGet, although it may be less (if there are not enough elements left in the collection).
        Throws:
        UIMA_IllegalStateException - if there is no more elements in the collection
        IOException - if an I/O failure occurs
        CollectionException - if there is some other problem with reading from the Collection
      • getCasDataInitializer

        @Deprecated
        CasDataInitializer getCasDataInitializer()
        Deprecated.
        As of v2.0 CAS Initializers are deprecated.
        Gets the CAS Data 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 Data Initializer for this Collection Reader
      • setCasInitializer

        @Deprecated
        void setCasInitializer​(CasDataInitializer aCasDataInitializer)
        Deprecated.
        As of v2.0 CAS Initializers are deprecated.
        Assigns a CAS Data 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:
        aCasDataInitializer - the CAS Data Initializer for this Collection Reader