com.mgz.afp.base

Class StructuredField

java.lang.Object

com.mgz.afp.base.StructuredField

All Implemented Interfaces:

IAFPDecodeableWriteable

Direct Known Subclasses:

BDA_BarCodeData, BDD_BarCodeDataDescriptor, CAT_ColorAttributeTable, CCP_ConditionalProcessingControl, CDD_ContainerDataDescriptor, CFC_CodedFontControl, CFI_CodedFontIndex, CPC_CodePageControl, CPD_CodePageDescriptor, CPI_CodePageIndex, CTC_ComposedTextControl, FDS_FixedDataSize, FDX_FixedDataText, FGD_FormEnvironmentGroupDescriptor, FNC_FontControl, FND_FontDescriptor, FNI_FontIndex, FNM_FontPatternsMap, FNO_FontOrientation, FNP_FontPosition, GAD_GraphicsData, GDD_GraphicsDataDescriptor, ICP_IMImageCellPosition, IDD_ImageDataDescriptor, IID_IMImageInputDescriptor, IOC_IMImageOutputControl, IPD_ImagePictureData, LLE_LinkLogicalElement, LNC_LineDescriptorCount, MBC_MapBarCodeObject, MCC_MediumCopyCount, MCD_MapContainerData, MCF_MapCodedFont_Format1, MMC_MediumModificationControl, OBP_ObjectAreaPosition, PGP_PagePosition_Format1, PTD_PresentationTextDataDescriptor_Format1, PTD_PresentationTextDataDescriptor_Format2, PTX_PresentationTextData, StructuredFieldBaseData, StructuredFieldBaseName, StructuredFieldBaseRepeatingGroups, StructuredFieldBaseTriplets, Undefined

public abstract class StructuredField
extends java.lang.Object
implements IAFPDecodeableWriteable

Base class for all StructuredFields.

Constructor Summary

Constructors

Constructor and Description
StructuredField()

Method Summary

Modifier and Type	Method and Description
static void	checkDataLength(byte[] sfData, int offset, int length, int minLength)
abstract 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.
static int	getActualLength(byte[] sfData, int offset, int length) Returns the actual length of data to process contained in sfData.
byte[]	getPadding() Returns the padding bytes of this structured field, or null if this structured field has no padding bytes.
StructuredFieldIntroducer	getStructuredFieldIntroducer() Returns the StructuredFieldIntroducer of this structured field.
boolean	isBeginSF() Returns true, if this structured field indicates the begin a complex structured field that may contain other structured fields.
boolean	isEndSF() Returns true, if this structured field indicates the end of a complex structured field that may contain other structured fields.
boolean	isShallow()
void	setPadding(byte[] padding) Sets the padding bytes of this structured field and set the padding flag. If the given padding is null the padding flag is revoked.
void	setStructuredFieldIntroducer(StructuredFieldIntroducer structuredFieldIntroducer) Sets the StructuredFieldIntroducer of this structured field.
java.lang.String	toString()
abstract void	writeAFP(java.io.OutputStream os, AFPParserConfiguration config) Writes the object to the given os encoded as AFP data.
protected void	writeFullStructuredField(java.io.OutputStream os, byte[] netPayloadWithoutSFIandPadding) Writes out the SFI, the given net payload, and padding data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StructuredField

public StructuredField()

Method Detail

checkDataLength

public static void checkDataLength(byte[] sfData,
                                   int offset,
                                   int length,
                                   int minLength)
                            throws AFPParserException

Throws:

AFPParserException

getActualLength

public static int getActualLength(byte[] sfData,
                                  int offset,
                                  int length)

Returns the actual length of data to process contained in sfData.

decodeAFP

public abstract 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.

writeAFP

public abstract void writeAFP(java.io.OutputStream os,
                              AFPParserConfiguration config)
                       throws java.io.IOException

Description copied from interface: IAFPDecodeableWriteable

Writes the object to the given os encoded as AFP data.

Specified by:

writeAFP in interface IAFPDecodeableWriteable

Parameters:

os - OutputStream to write to.

config - contains parameter used for encoding.

Throws:

java.io.IOException - if a problem occurs while writing to the given OutputStream.

getStructuredFieldIntroducer

public StructuredFieldIntroducer getStructuredFieldIntroducer()

Returns the StructuredFieldIntroducer of this structured field.

Returns:

the StructuredFieldIntroducer of this structured field.

setStructuredFieldIntroducer

public void setStructuredFieldIntroducer(StructuredFieldIntroducer structuredFieldIntroducer)

Sets the StructuredFieldIntroducer of this structured field.

Parameters:

structuredFieldIntroducer - the StructuredFieldIntroducer of this structured field.

getPadding

public byte[] getPadding()

Returns the padding bytes of this structured field, or null if this structured field has no padding bytes.

Returns:

padding bytes of this structured field, or null if this structured field has no padding bytes.

setPadding

public void setPadding(byte[] padding)

Sets the padding bytes of this structured field and set the padding flag.
If the given padding is null the padding flag is revoked.

Parameters:

padding - the padding bytes of this structured field, may be null.

writeFullStructuredField

protected void writeFullStructuredField(java.io.OutputStream os,
                                        byte[] netPayloadWithoutSFIandPadding)
                                 throws java.io.IOException

Writes out the SFI, the given net payload, and padding data.

Sets the length byte[0,1] of resulting SF Data and updates the StructuredFieldIntroducer.sfLength.

Parameters:

os - OutputStream to write to.

netPayloadWithoutSFIandPadding - the net payload without SFI and padding data. May be null or empty array.

Throws:

java.io.IOException - if writing to the given OutputStream fails.

isBeginSF

public boolean isBeginSF()

Returns true, if this structured field indicates the begin a complex structured field that may contain other structured fields. Returns false, if this structured field is not the begin a complex structured field.
Examples:
BPG_BeginPage, BBC_BeginBarCodeObject,

Returns:

true, if this structured field indicates the begin a complex structured field, false otherwise.

isEndSF

public boolean isEndSF()

Returns true, if this structured field indicates the end of a complex structured field that may contain other structured fields. Returns false, if this structured field is not the end a complex structured field.
Examples:
EPG_EndPage, EBC_EndBarCodeObject,

Returns:

true, if this structured field indicates the end of a complex structured field, false otherwise.

isShallow

public boolean isShallow()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object