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

Class FullyQualifiedNameTriplet

java.lang.Object
org.apache.fop.afp.modca.AbstractAFPObject
org.apache.fop.afp.modca.triplets.AbstractTriplet
org.apache.fop.afp.modca.triplets.FullyQualifiedNameTriplet
All Implemented Interfaces:
Triplet, Streamable, StructuredData
public class FullyQualifiedNameTriplet extends AbstractTriplet
A Fully Qualified Name triplet enable the identification and referencing of objects using Gloabl Identifiers (GIDs).

  • Field Details

    • TYPE_REPLACE_FIRST_GID_NAME

      public static final byte TYPE_REPLACE_FIRST_GID_NAME
      This GID replaces the first parameter in the structured field that contains a GID name.
      See Also:

    • TYPE_FONT_FAMILY_NAME

      public static final byte TYPE_FONT_FAMILY_NAME
      This triplet contains the name of a font family.
      See Also:

    • TYPE_FONT_TYPEFACE_NAME

      public static final byte TYPE_FONT_TYPEFACE_NAME
      This triplet contains the name of a font typeface.
      See Also:

    • TYPE_MODCA_RESOURCE_HIERARCHY_REF

      public static final byte TYPE_MODCA_RESOURCE_HIERARCHY_REF
      This triplet specifies a reference to the MO:DCA resource hierarchy.
      See Also:

    • TYPE_BEGIN_RESOURCE_GROUP_REF

      public static final byte TYPE_BEGIN_RESOURCE_GROUP_REF
      The triplet contains a GID reference to a begin resource group structured field.
      See Also:

    • TYPE_ATTRIBUTE_GID

      public static final byte TYPE_ATTRIBUTE_GID
      The triplet contains a GID reference to a document attribute.
      See Also:

    • TYPE_PROCESS_ELEMENT_GID

      public static final byte TYPE_PROCESS_ELEMENT_GID
      The triplet contains the GID of a process element.
      See Also:

    • TYPE_BEGIN_PAGE_GROUP_REF

      public static final byte TYPE_BEGIN_PAGE_GROUP_REF
      The triplet contains a reference to a begin page group structured field.
      See Also:

    • TYPE_MEDIA_TYPE_REF

      public static final byte TYPE_MEDIA_TYPE_REF
      The triplet contains a reference to a media type.
      See Also:

    • TYPE_COLOR_MANAGEMENT_RESOURCE_REF

      public static final byte TYPE_COLOR_MANAGEMENT_RESOURCE_REF
      The triplet contains a reference to a color management resource.
      See Also:

    • TYPE_DATA_OBJECT_FONT_BASE_FONT_ID

      public static final byte TYPE_DATA_OBJECT_FONT_BASE_FONT_ID
      The triplet contains a reference to a data-object font file that defines a base font.
      See Also:

    • TYPE_DATA_OBJECT_FONT_LINKED_FONT_ID

      public static final byte TYPE_DATA_OBJECT_FONT_LINKED_FONT_ID
      The triplet contains a reference to a data-object font file that defines a linked font.
      See Also:

    • TYPE_BEGIN_DOCUMENT_REF

      public static final byte TYPE_BEGIN_DOCUMENT_REF
      The triplet contains a reference to a begin document structured field.
      See Also:

    • TYPE_BEGIN_RESOURCE_OBJECT_REF

      public static final byte TYPE_BEGIN_RESOURCE_OBJECT_REF
      The triplet contains a reference to a begin structured field associated with a resource; or contains a GID reference to a coded font.
      See Also:

    • TYPE_CODE_PAGE_NAME_REF

      public static final byte TYPE_CODE_PAGE_NAME_REF
      The triplet contains a GID reference to a code page that specifies the code points and graphic character names for a coded font.
      See Also:

    • TYPE_FONT_CHARSET_NAME_REF

      public static final byte TYPE_FONT_CHARSET_NAME_REF
      The triplet contains a GID name reference to a font character set that specifies a set of graphics characters.
      See Also:

    • TYPE_BEGIN_PAGE_REF

      public static final byte TYPE_BEGIN_PAGE_REF
      The triplet contains a GID reference to a begin page structured field.
      See Also:

    • TYPE_BEGIN_MEDIUM_MAP_REF

      public static final byte TYPE_BEGIN_MEDIUM_MAP_REF
      The triplet contains a GID reference to a begin medium map structured field.
      See Also:

    • TYPE_CODED_FONT_NAME_REF

      public static final byte TYPE_CODED_FONT_NAME_REF
      The triplet contains a GID reference to a coded font, which identifies a specific code page and a specific font character set.
      See Also:

    • TYPE_BEGIN_DOCUMENT_INDEX_REF

      public static final byte TYPE_BEGIN_DOCUMENT_INDEX_REF
      The triplet contains a GID reference to a begin document index structured field.
      See Also:

    • TYPE_BEGIN_OVERLAY_REF

      public static final byte TYPE_BEGIN_OVERLAY_REF
      The triplet contains a GID reference to a begin overlay structured field.
      See Also:

    • TYPE_DATA_OBJECT_INTERNAL_RESOURCE_REF

      public static final byte TYPE_DATA_OBJECT_INTERNAL_RESOURCE_REF
      The triplet contains a GID reference to a resource used by a data object.
      See Also:

    • TYPE_INDEX_ELEMENT_GID

      public static final byte TYPE_INDEX_ELEMENT_GID
      The triplet contains a GID reference to an index element structured field.
      See Also:

    • TYPE_OTHER_OBJECT_DATA_REF

      public static final byte TYPE_OTHER_OBJECT_DATA_REF
      The triplet contains a reference to other object data which may or may not be defined by an IBM presentation architecture.
      See Also:

    • TYPE_DATA_OBJECT_EXTERNAL_RESOURCE_REF

      public static final byte TYPE_DATA_OBJECT_EXTERNAL_RESOURCE_REF
      The triplet contains a reference to a resource used by a data object. The GID may be a filename or any other identifier associated with the resource and is used to located the resource object in the resource hierarchy. The data object that uses the resource may or may not be defined by an IBM presentation architecture.
      See Also:

    • FORMAT_CHARSTR

      public static final byte FORMAT_CHARSTR
      The GID is a character encoded name.
      See Also:

    • FORMAT_OID

      public static final byte FORMAT_OID
      the GID is a ASN.1 object identifier (OID).
      See Also:

    • FORMAT_URL

      public static final byte FORMAT_URL
      the GID is a uniform resource locator (URL).
      See Also:

  • Constructor Details

    • FullyQualifiedNameTriplet

      public FullyQualifiedNameTriplet(byte type, byte format, String fqName, boolean utf16be)
      Main constructor
      Parameters:
      type - the fully qualified name type
      format - the fully qualified name format
      fqName - the fully qualified name

  • Method Details

    • getFullyQualifiedName

      public String getFullyQualifiedName()
      Returns the actual fully qualified name
      Returns:
      the actual fully qualified name

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • 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.