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.util
Interface TCasFormatter

All Known Implementing Classes:
  TCasToInlineXml

    public interface TCasFormatter

Interface for components that generate a String representation of a CAS.

Method Summary
`String` | `format(CAS aCAS)` Produces a string representation of a CAS.
`String` | `format(CAS aCAS, FSMatchConstraint aFilter)` Produces a string representation of a CAS.

Method Detail

### format

    String format(CAS aCAS)
                  throws CASException

  Produces a string representation of a CAS.

  Parameters:
    `aCAS` - the CAS to be formatted
  Returns:
    a string representation of `aCAS`.
  Throws:
    `CASException` - if an exception occurs reading from the CAS

### format

    String format(CAS aCAS,
                  FSMatchConstraint aFilter)
                  throws CASException

  Produces a string representation of a CAS. Only those feature structures that satisfy the specified filter will appear in the string representation.

  Parameters:
    `aCAS` - the CAS to be formatted
    `aFilter` - a constraint which FeatureStructures must satisfy in order to be included in the resulting string
  Returns:
    a string representation of `aCAS`.
  Throws:
    `CASException` - if an exception occurs reading from the CAS

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.