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.base_cpm
Interface CasDataInitializer

All Superinterfaces:
  ConfigurableResource, Resource

All Known Implementing Classes:
  CasDataInitializer_ImplBase

Deprecated. As of v2.0, CAS Initializers are deprecated. A component that performs an operation like HTML detagging should instead be implemented as a "multi-Sofa" annotator. See `XmlDetagger` for an example.

    public interface CasDataInitializer

extends ConfigurableResource

A component that takes an Object (for text analysis applications, this will often be a String) and creates a `CasData`.

An example of a `CasDataInitializer` would be a component that takes an HTML document and populates a CasData with the plain (detagged) text as well as document structure annotations that were inferred from the locations of certain HTML tags (paragraphs and headings, for example).

Field Summary

Fields inherited from interface org.apache.uima.resource.Resource
`PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_PARAM_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT`

Method Summary
`ProcessingResourceMetaData` | `getCasInitializerMetaData()` Deprecated. Gets the metadata that describes this `CasDataInitializer`.
`CasData` | `initializeCas(Object aObj)` Deprecated. Reads content and metadata from an Object and creates a `CasData`.

Methods inherited from interface org.apache.uima.resource.ConfigurableResource
`getConfigParameterValue, getConfigParameterValue, reconfigure, setConfigParameterValue, setConfigParameterValue`

Methods inherited from interface org.apache.uima.resource.Resource
`destroy, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, initialize, setLogger`

Method Detail

### initializeCas

    CasData initializeCas(Object aObj)
                          throws CollectionException,
                                 IOException

  Deprecated.
  Reads content and metadata from an Object and creates a `CasData`.

  Parameters:
    `aObj` - the Object to process
  Returns:
    CasData corresponding to the Object
  Throws:
    `CollectionException` - if an error occurs during initialization of the CAS
    `IOException` - if an I/O failure occurs

### getCasInitializerMetaData

    ProcessingResourceMetaData getCasInitializerMetaData()

  Deprecated.
  Gets the metadata that describes this `CasDataInitializer`.

  Returns:
    an object containing all metadata for this CasDataInitializer

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.