Triplet (alpheusafpparser 0.2.2 API)

java.lang.Object
- com.mgz.afp.triplets.Triplet

All Implemented Interfaces:

IAFPDecodeableWriteable

Direct Known Subclasses:

Triplet.AreaDefinition, Triplet.AttributeQualifier, Triplet.AttributeValue, Triplet.CharacterRotation, Triplet.CMRTagFidelity, Triplet.CodedGraphicCharacterSetGlobalID, Triplet.ColorFidelity, Triplet.ColorManagementResourceDescriptor, Triplet.ColorSpecification, Triplet.Comment, Triplet.DataObjectFontDescriptor, Triplet.DescriptorPosition, Triplet.DeviceAppearance, Triplet.EncodingSchemeID, Triplet.ExtendedResourceLocalIdentifier, Triplet.FinishingFidelity, Triplet.FinishingOperation, Triplet.FontCodedGraphicCharacterSetGlobalID, Triplet.FontDescriptorSpecification, Triplet.FontFidelity, Triplet.FontHorizontalScaleFactor, Triplet.FontResolutionAndMetricTechnology, Triplet.FullyQualifiedName, Triplet.ImageResolution, Triplet.IMMInsertionTriplet, Triplet.LineDataObjectPositionMigration, Triplet.LocaleSelector, Triplet.LocalObjectDateAndTimeStamp, Triplet.MappingOption, Triplet.MeasurementUnits, Triplet.MediaEjectControl, Triplet.MediaFidelity, Triplet.MediumMapPageNumber, Triplet.MediumOrientation, Triplet.MODCAInterchangeSet, Triplet.ObjectAreaSize, Triplet.ObjectByteExtent, Triplet.ObjectByteOffset, Triplet.ObjectChecksum, Triplet.ObjectClassification, Triplet.ObjectContainerPresentationSpaceSize, Triplet.ObjectCount, Triplet.ObjectFunctionSetSpecification_Retired, Triplet.ObjectOffset, Triplet.ObjectOriginIdentifier, Triplet.ObjectStructuredFieldExtent, Triplet.ObjectStructuredFieldOffset, Triplet.PageOverlayConditionalProcessing, Triplet.PagePositionInformation, Triplet.ParameterValue, Triplet.PresentationControl, Triplet.PresentationSpaceMixingRule, Triplet.PresentationSpaceResetMixing, Triplet.RenderingIntent, Triplet.ResourceLocalIdentifier, Triplet.ResourceObjectInclude, Triplet.ResourceObjectType, Triplet.ResourceSectionNumber, Triplet.ResourceUsageAttribute, Triplet.TextFidelity, Triplet.TextOrientation, Triplet.TonerSaver, Triplet.Undefined, Triplet.UniversalDateAndTimeStamp, Triplet.UP3iFinishingOperation
```
public abstract class Triplet
extends java.lang.Object
implements IAFPDecodeableWriteable
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Triplet.AreaDefinition` MOIDCA, page 397 The Area Definition triplet is used to define the position and size of a rectangular area on a document component presentation space.
`static class`	`Triplet.AttributeQualifier` MODCA, page 436.
`static class`	`Triplet.AttributeValue` MODCA page 388. The Attribute Value triplet is used to specify a value for a document attribute.
`static class`	`Triplet.CharacterRotation` MODCA page 386. The Character Rotation triplet is used to specify character rotation relative to the Character coordinate system.
`static class`	`Triplet.CMRTagFidelity` MODCA, page 471.
`static class`	`Triplet.CodedGraphicCharacterSetGlobalID` MO:DCA, page 349. The Coded Graphic Character Set Global Identifier (CGCSGID) triplet is used to establish the values of the code page and character set for interpretation of all structured field parameters having a CHAR data type, such as name parameters, except where such parameters define a fixed encoding.
`static class`	`Triplet.ColorFidelity` MODCA, page 432.
`static class`	`Triplet.ColorManagementResourceDescriptor` MODCA, page 466.
`static class`	`Triplet.ColorSpecification` MODCA, page 398. The Color Specification triplet is used to specify a color value and defines the color space and encoding for that value.
`static class`	`Triplet.Comment` MODCA, page 418.
`static class`	`Triplet.DataObjectFontDescriptor` MODCA, page 456. The Data-Object Font Descriptor triplet is used to specify the parameters needed to render a data-object font.
`static class`	`Triplet.DescriptorPosition` MODCA page 389. The Descriptor Position triplet is used to associate an Object Area Position structured field with an Object Area Descriptor structured field.
`static class`	`Triplet.DeviceAppearance` MODCA, page 473.
`static class`	`Triplet.EncodingSchemeID` MODCA, page 403. The Encoding Scheme ID triplet is used to specify the encoding scheme associated with a code page.
`static class`	`Triplet.ExtendedResourceLocalIdentifier` MODCA page 381. The Extended Resource Local Identifier triplet specifies a resource type and a four-byte local identifier or LID.
`static class`	`Triplet.FinishingFidelity` MODCA, page 454.
`static class`	`Triplet.FinishingOperation` MODCA, page 442.
`static class`	`Triplet.FontCodedGraphicCharacterSetGlobalID` MO:DCA, page 378. The Font Coded Graphic Character Set Global Identifier triplet is used to specify the code page and character set for a coded font.
`static class`	`Triplet.FontDescriptorSpecification` MO:DCA, page 374. The Font Descriptor Specification triplet specifies the attributes of the desired font in a coded font reference.
`static class`	`Triplet.FontFidelity` MODCA, page 435.
`static class`	`Triplet.FontHorizontalScaleFactor` MODCA, page 413.
`static class`	`Triplet.FontResolutionAndMetricTechnology` MODCA, page 440.
`static class`	`Triplet.FullyQualifiedName` MO:DCA, page 353. The Fully Qualified Name triplet enables the identification and referencing of objects using Global Identifiers (GIDs).
`static class`	`Triplet.GlobalID_Format` Specifies the GID format
`static class`	`Triplet.GlobalID_Use` Specifies how the GID will be used, eg.
`static class`	`Triplet.ImageResolution` MODCA, page 474.
`static class`	`Triplet.IMMInsertionTriplet` MODCA page 582, retired function.
`static class`	`Triplet.LineDataObjectPositionMigration` MODCA page 572, retired function. The use of this triplet is restricted to the BBC, BGR, BII, BIM, IPS structured fields for the migration of line-data containing bar code objects, graphic objects, image objects, and page segments to MO:DCA document format.
`static class`	`Triplet.LocaleSelector` MODCA, page 461.
`static class`	`Triplet.LocalObjectDateAndTimeStamp` MODCA, page 416. The Local Date and Time Stamp triplet specifies a date and time stamp to be associated with an object.
`static class`	`Triplet.MappingOption` MO:DCA, page 365. The Mapping Option is used to specify the mapping of a data object presentation space to an object area.
`static class`	`Triplet.MeasurementUnits` MODCA, page 395. The Measurement Units triplet is used to specify the units of measure for a presentation space.
`static class`	`Triplet.MediaEjectControl` MODCA page 390. The Media Eject Control triplet is used to specify the type of media eject that is performed and the type of controls that are activated when a new medium map is invoked and N-up partitioning is specified.
`static class`	`Triplet.MediaFidelity` MODCA, page 452.
`static class`	`Triplet.MediumMapPageNumber` MODCA, page 406. The Medium Map Page Number triplet is used to specify the sequence number of the page in the set of sequential pages whose presentation is controlled by the most recently activated medium map.
`static class`	`Triplet.MediumOrientation` MODCA, page 419.
`static class`	`Triplet.MODCAInterchangeSet` MO:DCA, page 372. The MO:DCA Interchange Set triplet identifies the interchange set and the data stream type.
`static class`	`Triplet.ObjectAreaSize` MODCA, page 396. The Object Area Sizeand Y directions.
`static class`	`Triplet.ObjectByteExtent` MODCA, page 407. The Object Byte Extent triplet is used to specify the number of bytes contained in an object.
`static class`	`Triplet.ObjectByteOffset` MODCA page 387. The Object Byte Offset triplet is used to specify the byte offset of an indexed object within a document.
`static class`	`Triplet.ObjectChecksum` MODCA page 579
`static class`	`Triplet.ObjectClassification` MO:DCA, page 368. The Object Classification is used to classify and identify object data.
`static class`	`Triplet.ObjectContainerPresentationSpaceSize` MODCA, page 476. The Object Container Presentation Space Size triplet specifies the presentation space size, or how such a size is determined, for certain container object types.
`static class`	`Triplet.ObjectCount` MODCA, page 414. The Object Count triplet specifies the number of subordinate objects of a particular type contained in an object.
`static class`	`Triplet.ObjectFunctionSetSpecification_Retired` RETIRED The use of this triplet is restricted to the BDT structured field in the following products: Pre-year 2012 AFP applications. The Object Function Set Specification triplet is used to specify the Object Content Architecture (OCA) level for objects in a MO:DCA document.
`static class`	`Triplet.ObjectOffset` MODCA, page 410.
`static class`	`Triplet.ObjectOriginIdentifier` MODCA page 581.
`static class`	`Triplet.ObjectStructuredFieldExtent` MODCA, page 409.
`static class`	`Triplet.ObjectStructuredFieldOffset` MODCA, page 408. The Object Structured Field Offset triplet is used to specify the structuredoffset of an indexed object from the beginning of the document.
`static class`	`Triplet.PageOverlayConditionalProcessing` MODCA page 576. The use of this triplet is restricted to products that generate or process the retired MO:DCA interchange set MO:DCA IS/2.
`static class`	`Triplet.PagePositionInformation` MODCA, page 437. The Page Position Information triplet is used to tag a page with the Page Position (PGP) structured field repeating group information that is used to present the page.
`static class`	`Triplet.ParameterValue` MODCA, page 438.
`static class`	`Triplet.PresentationControl` MODCA, page 439. The Presentation Control triplet specifies flags that control the presentation of an object.
`static class`	`Triplet.PresentationSpaceMixingRule` MODCA, page 425.
`static class`	`Triplet.PresentationSpaceResetMixing` MODCA, page 423. This triplet is used to specify the resulting appearance when data in a new presentation space is merged with data in an existing presentation space.
`static class`	`Triplet.RenderingIntent` MODCA, page 468.
`static class`	`Triplet.ResourceLocalIdentifier` MODCA page 383. The Resource Local Identifier triplet may be used to specify a resource type and a one-byte local identifier or LID.
`static class`	`Triplet.ResourceObjectInclude` MODCA, page 421. The Resource Object Include triplet identifies an object to be included on a presentation space at a specified position.
`static class`	`Triplet.ResourceObjectType` MODCA page 379. The Resource Object Type triplet identifies the type of object enveloped by the Begin Resource (BRS) and End Resource (ERS) structured fields. UNFORTUNATLY: A similar triplet, the Object Function Set Specification triplet, that unfortunately also uses triplet ID X'21', is retired but is still used on the BDT structured field; see “Object Function Set Specification Triplet X'21'” on page 570.
`static class`	`Triplet.ResourceSectionNumber` MODCA page 385. The Resource Section Number triplet specifies a coded font section number.
`static class`	`Triplet.ResourceUsageAttribute` MODCA page 578. The use of this triplet is restricted to products that generate or process the retired MO:DCA interchange set MO:DCA IS/2.
`static class`	`Triplet.TextFidelity` MODCA, page 450.
`static class`	`Triplet.TextOrientation` MODCA page 569, retired function.
`static class`	`Triplet.TonerSaver` MODCA, page 430.
`static class`	`Triplet.TripletID`
`static class`	`Triplet.Undefined` The `Triplet.Undefined` triplet is used when problem occur with corrupted AFP Data.
`static class`	`Triplet.UniversalDateAndTimeStamp` MODCA, page 427. The Universal Date and Time Stamp triplet specifies a date and time in accordance with the format defined in ISO 8601: 1988 (E).
`static class`	`Triplet.UP3iFinishingOperation` MODCA, page 461. The UP3i Finishing Operation triplet is used to specify finishing operations that are to be applied to media.

Field Summary

Fields
Modifier and Type Field and Description

static short UNFORTUNATE_TRIPLETID

Fields
Modifier and Type	Field and Description
`static short`	`UNFORTUNATE_TRIPLETID`

Constructor Summary

Constructors
Constructor and Description

Triplet()

Constructors
Constructor and Description
`Triplet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`decodeAFP(byte[] sfData, int offset, int length, AFPParserConfiguration config)` Decodes the given AFP data. Parameter length specifies the length in bytes of the data to be decoded, beginning with position offset.
`short`	`getLength()`
`Triplet.TripletID`	`getTripletID()`
`void`	`setLength(short length)`
`void`	`setTripletID(Triplet.TripletID tripletID)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.mgz.afp.exceptions.IAFPDecodeableWriteable
writeAFP

- Field Detail
  - UNFORTUNATE_TRIPLETID
```
public static short UNFORTUNATE_TRIPLETID
```
- Constructor Detail
  - Triplet
```
public Triplet()
```
- Method Detail
  - decodeAFP
```
public void decodeAFP(byte[] sfData,
                      int offset,
                      int length,
                      AFPParserConfiguration config)
               throws AFPParserException
```
    Description copied from interface: IAFPDecodeableWriteable
    
    Decodes the given AFP data.
    Parameter length specifies the length in bytes of the data to be decoded, beginning with position offset. If parameter length has a value of -1, the given data array is decoded up to the end of the array.
    
    Specified by:
    
    decodeAFP in interface IAFPDecodeableWriteable
    
    Parameters:
    
    sfData - contains the AFP data to decode.
    
    offset - the byte index position where the decoding should start.
    
    length - the length in bytes of the data to be decoded, beginning with position offset.
    
    config - contains parameter used for decoding.
    
    Throws:
    
    AFPParserException - if the given AFP data are invalid.
  - getLength
```
public short getLength()
```
  - setLength
```
public void setLength(short length)
```
  - getTripletID
```
public Triplet.TripletID getTripletID()
```
  - setTripletID
```
public void setTripletID(Triplet.TripletID tripletID)
```

Class Triplet

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.mgz.afp.exceptions.IAFPDecodeableWriteable

Field Detail

UNFORTUNATE_TRIPLETID

Constructor Detail

Triplet

Method Detail

decodeAFP

getLength

setLength

getTripletID

setTripletID