Package org.apache.fop.afp.modca

Class AbstractTripletStructuredObject

java.lang.Object
org.apache.fop.afp.modca.AbstractAFPObject
org.apache.fop.afp.modca.AbstractStructuredObject
org.apache.fop.afp.modca.AbstractTripletStructuredObject
All Implemented Interfaces:
Streamable
Direct Known Subclasses:
AbstractDescriptor, AbstractNamedAFPObject, MapContainerData, MapDataResource, MapImageObject, PreprocessPresentationObject, PresentationEnvironmentControl, TagLogicalElement
public abstract class AbstractTripletStructuredObject extends AbstractStructuredObject
A MODCA structured object base class providing support for Triplets

  • Field Details

  • Constructor Details

    • AbstractTripletStructuredObject

      public AbstractTripletStructuredObject()

  • Method Details

    • getTripletDataLength

      protected int getTripletDataLength()
      Returns the triplet data length
      Returns:
      the triplet data length

    • hasTriplets

      public boolean hasTriplets()
      Returns true when this structured field contains triplets
      Returns:
      true when this structured field contains triplets

    • writeTriplets

      protected void writeTriplets(OutputStream os) throws IOException
      Writes any triplet data
      Parameters:
      os - The stream to write to
      Throws:
      IOException - The stream to write to

    • hasTriplet

      public boolean hasTriplet(byte tripletId)
      Returns true of this structured field has the given triplet
      Parameters:
      tripletId - the triplet identifier
      Returns:
      true if the structured field has the given triplet

    • addTriplet

      public void addTriplet(AbstractTriplet triplet)
      Adds a triplet to this structured object
      Parameters:
      triplet - the triplet to add

    • addTriplets

      public void addTriplets(Collection<AbstractTriplet> tripletCollection)
      Adds a list of triplets to the triplets contained within this structured field
      Parameters:
      tripletCollection - a collection of triplets

    • getTriplets

      protected List<AbstractTriplet> getTriplets()
      Returns:
      the triplet list pertaining to this resource

    • setFullyQualifiedName

      public void setFullyQualifiedName(byte fqnType, byte fqnFormat, String fqName)
      Sets the fully qualified name of this structured field
      Parameters:
      fqnType - the fully qualified name type of this resource
      fqnFormat - the fully qualified name format of this resource
      fqName - the fully qualified name of this resource

    • setFullyQualifiedName

      public void setFullyQualifiedName(byte fqnType, byte fqnFormat, String fqName, boolean utf16be)

    • getFullyQualifiedName

      public String getFullyQualifiedName()
      Returns:
      the fully qualified name of this triplet or null if it does not exist

    • setObjectClassification

      public void setObjectClassification(byte objectClass, Registry.ObjectType objectType, boolean dataInContainer, boolean containerHasOEG, boolean dataInOCD)
      Sets the objects classification
      Parameters:
      objectClass - the classification of the object
      objectType - the MOD:CA registry object type entry for the given object/component type of the object
      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

    • setComment

      public void setComment(String commentString)
      Sets a comment on this resource
      Parameters:
      commentString - a comment string