Package org.apache.fop.afp.modca.triplets

Class ObjectClassificationTriplet

java.lang.Object
org.apache.fop.afp.modca.AbstractAFPObject
org.apache.fop.afp.modca.triplets.AbstractTriplet
org.apache.fop.afp.modca.triplets.ObjectClassificationTriplet
All Implemented Interfaces:
Triplet, Streamable, StructuredData
public class ObjectClassificationTriplet extends AbstractTriplet
The Object Classification is used to classify and identify object data. The object data may or may not be defined by an IBM presentation architecture

  • Field Details

    • CLASS_TIME_INVARIANT_PAGINATED_PRESENTATION_OBJECT

      public static final byte CLASS_TIME_INVARIANT_PAGINATED_PRESENTATION_OBJECT
      The scope of this object is the including page or overlay
      See Also:

    • CLASS_TIME_VARIANT_PRESENTATION_OBJECT

      public static final byte CLASS_TIME_VARIANT_PRESENTATION_OBJECT
      The scope of this object is not defined
      See Also:

    • CLASS_EXECUTABLE_PROGRAM

      public static final byte CLASS_EXECUTABLE_PROGRAM
      This is not a presentation object, the scope of this object is not defined
      See Also:

    • CLASS_SETUP_FILE

      public static final byte CLASS_SETUP_FILE
      Setup information file, document level. This is not a presentation object,
      See Also:

    • CLASS_SECONDARY_RESOURCE

      public static final byte CLASS_SECONDARY_RESOURCE
      This is a resource used by a presentation object that may itself be a resource. The scope of the resource is the object that uses the resource.
      See Also:

    • CLASS_DATA_OBJECT_FONT

      public static final byte CLASS_DATA_OBJECT_FONT
      Data object font. This is a non-FOCA font resource used to present text in a data object. The scope of the resource is the object that uses the resource.
      See Also:

  • Constructor Details

    • ObjectClassificationTriplet

      public ObjectClassificationTriplet(byte objectClass, Registry.ObjectType objectType, boolean dataInContainer, boolean containerHasOEG, boolean dataInOCD)
      Main constructor
      Parameters:
      objectClass - the object class type
      objectType - the object type registry entry
      dataInContainer - whether the data resides in the container
      containerHasOEG - whether the container has an object environment group
      dataInOCD - whether the data resides in a object container data structured field

    • ObjectClassificationTriplet

      public ObjectClassificationTriplet(byte objectClass, Registry.ObjectType objectType, boolean dataInContainer, boolean containerHasOEG, boolean dataInOCD, String objLev, String compName)
      Fully parameterized constructor
      Parameters:
      objectClass - the object class type
      objectType - the object type registry entry
      dataInContainer - whether the data resides in the container
      containerHasOEG - whether the container has an object environment group
      dataInOCD - whether the data resides in a object container data structured field
      objLev - the release level or version number of the object type
      compName - the name of the company or organization that owns the object definition

  • Method Details

    • getStructureFlagsAsBytes

      public byte[] getStructureFlagsAsBytes(boolean dataInContainer, boolean containerHasOEG, boolean dataInOCD)
      Returns the structured field flags
      Parameters:
      dataInContainer - true if the object data in carried in the object container
      containerHasOEG - true if the object container has an object environment group
      dataInOCD - true if the object container data carries the object data
      Returns:
      the byte value of this structure

    • getDataLength

      public int getDataLength()
      Returns the data length of this structured field
      Returns:
      the data length of this structured field

    • writeToStream

      public void writeToStream(OutputStream os) throws IOException
      DataStream objects must implement the writeToStream() method to write its data to the given OutputStream
      Parameters:
      os - the outputsteam stream
      Throws:
      IOException - an I/O exception of some sort has occurred.