Package org.apache.uima.cas

Enum Class SerialFormat

java.lang.Object
java.lang.Enum<SerialFormat>
org.apache.uima.cas.SerialFormat
All Implemented Interfaces:
Serializable, Comparable<SerialFormat>, Constable
public enum SerialFormat extends Enum<SerialFormat>
The various forms of serialization (typically of the CAS)

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BINARY
    Plain custom binary serialized CAS without type system, no filtering
    BINARY_TSI
    Plain custom binary serialized CAS, no filtering, plus serialized TSI used to reinitialize the CAS
    COMPRESSED
    Binary compressed CAS without type system, no filtering (form 4)
    COMPRESSED_FILTERED
    Binary compressed CAS with reachability and type and feature filtering (form 6)
    COMPRESSED_FILTERED_TS
    Binary compressed form 6 CAS with embedded type system representing the type system encoding the serialization specifies the type system used for the serialized form
    COMPRESSED_FILTERED_TSI
    Type system and index specification included used to reinitialize the CAS and specifies the type system used for the serialized form
    COMPRESSED_PROJECTION
    with subset of views (not in use)
    COMPRESSED_TSI
    Binary Compressed Form 4, plus serialized TSI used to reinitialize the CAS
    SERIALIZED
    Java-serialized CAS without type system
    SERIALIZED_TSI
    Java-serialized CAS with type system and index definitions The Type System and Index Definition replaces the CAS's when deserializing.
    UNKNOWN
    Unknown format
    XCAS
    XML-serialized CAS, using XML version 1.0
    XCAS_1_1
    XML-serialized CAS, using XML version 1.1
    XMI
    XML-serialized CAS, using XML version 1.0
    XMI_1_1
    XML-serialized CAS, using XML version 1.1
    XMI_1_1_PRETTY
    XML-serialized CAS, using XML version 1.1 - pretty-printed
    XMI_PRETTY
    XML-serialized CAS, using XML version 1.0 - pretty-printed

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDefaultFileExtension()
     
    static SerialFormat
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static SerialFormat[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • UNKNOWN

      public static final SerialFormat UNKNOWN
      Unknown format

    • XCAS

      public static final SerialFormat XCAS
      XML-serialized CAS, using XML version 1.0

    • XMI

      public static final SerialFormat XMI
      XML-serialized CAS, using XML version 1.0

    • BINARY

      public static final SerialFormat BINARY
      Plain custom binary serialized CAS without type system, no filtering

    • COMPRESSED

      public static final SerialFormat COMPRESSED
      Binary compressed CAS without type system, no filtering (form 4)

    • COMPRESSED_FILTERED

      public static final SerialFormat COMPRESSED_FILTERED
      Binary compressed CAS with reachability and type and feature filtering (form 6)

    • COMPRESSED_PROJECTION

      public static final SerialFormat COMPRESSED_PROJECTION
      with subset of views (not in use)

    • SERIALIZED

      public static final SerialFormat SERIALIZED
      Java-serialized CAS without type system

    • SERIALIZED_TSI

      public static final SerialFormat SERIALIZED_TSI
      Java-serialized CAS with type system and index definitions The Type System and Index Definition replaces the CAS's when deserializing.

    • COMPRESSED_FILTERED_TS

      public static final SerialFormat COMPRESSED_FILTERED_TS
      Binary compressed form 6 CAS with embedded type system representing the type system encoding the serialization specifies the type system used for the serialized form

    • COMPRESSED_FILTERED_TSI

      public static final SerialFormat COMPRESSED_FILTERED_TSI
      Type system and index specification included used to reinitialize the CAS and specifies the type system used for the serialized form

    • BINARY_TSI

      public static final SerialFormat BINARY_TSI
      Plain custom binary serialized CAS, no filtering, plus serialized TSI used to reinitialize the CAS

    • COMPRESSED_TSI

      public static final SerialFormat COMPRESSED_TSI
      Binary Compressed Form 4, plus serialized TSI used to reinitialize the CAS

    • XCAS_1_1

      public static final SerialFormat XCAS_1_1
      XML-serialized CAS, using XML version 1.1

    • XMI_1_1

      public static final SerialFormat XMI_1_1
      XML-serialized CAS, using XML version 1.1

    • XMI_PRETTY

      public static final SerialFormat XMI_PRETTY
      XML-serialized CAS, using XML version 1.0 - pretty-printed

    • XMI_1_1_PRETTY

      public static final SerialFormat XMI_1_1_PRETTY
      XML-serialized CAS, using XML version 1.1 - pretty-printed

  • Method Details

    • values

      public static SerialFormat[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SerialFormat valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getDefaultFileExtension

      public String getDefaultFileExtension()