Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.uima.collection.metadata
Interface CpeCollectionReaderIterator

All Superinterfaces:
  Cloneable, MetaDataObject, Serializable, XMLizable

    public interface CpeCollectionReaderIterator

extends MetaDataObject

An object that holds configuration that is part of the CPE descriptor. It provides the means of configuring CPE Collection Reader Iterator.

Method Summary
`CasProcessorConfigurationParameterSettings` | `getConfigurationParameterSettings()` Return override parameters.
`CpeComponentDescriptor` | `getDescriptor()` Return Descriptor
`CpeSofaMappings` | `getSofaNameMappings()`
`void` | `setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings settings)` Set parameters that will override params defined in the Collection Reader component descriptor.
`void` | `setDescriptor(CpeComponentDescriptor descriptor)` Associate Descriptor with the Collection Reader Iterator
`void` | `setSofaNameMappings(CpeSofaMappings mappings)` Set Sofa Name Mappings

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

### getDescriptor

    CpeComponentDescriptor getDescriptor()

  Return Descriptor

  Returns:

### setDescriptor

    void setDescriptor(CpeComponentDescriptor descriptor)

  Associate Descriptor with the Collection Reader Iterator

  Parameters:
    `descriptor` -

### getConfigurationParameterSettings

    CasProcessorConfigurationParameterSettings getConfigurationParameterSettings()

  Return override parameters. These override parameters in the Collection Reader component descriptor.

  Returns:

### setConfigurationParameterSettings

    void setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings settings)

  Set parameters that will override params defined in the Collection Reader component descriptor.

  Parameters:
    `settings` -

### getSofaNameMappings

    CpeSofaMappings getSofaNameMappings()

### setSofaNameMappings

    void setSofaNameMappings(CpeSofaMappings mappings)

  Set Sofa Name Mappings

  Parameters:
    `mappings` -

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 The Apache Software Foundation. All Rights Reserved.