com.mgz.afp.lineData

Class RCD_RecordDescriptor

java.lang.Object

com.mgz.afp.base.StructuredField

com.mgz.afp.base.StructuredFieldBaseTriplets

com.mgz.afp.lineData.RCD_RecordDescriptor

All Implemented Interfaces:

IHasTriplets, IAFPDecodeableWriteable

public class RCD_RecordDescriptor
extends StructuredFieldBaseTriplets

* Programming Guide and Line Data Reference(ha3l3r04.pdf), page 127.

The Record Descriptor structured field contains information, such as record position, text orientation, font selection, field selection, and conditional processing identification, used to format line data that consists of records tagged with record identifiers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RCD_RecordDescriptor.RCD_Flag

Field Summary

Fields inherited from class com.mgz.afp.base.StructuredFieldBaseTriplets

triplets

Constructor Summary

Constructors

Constructor and Description
RCD_RecordDescriptor()

Method Summary

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.
int	getAdditionalBaselineIncrement()
AFPOrientation	getBaselineOrientation()
int	getBaselinePosition()
int	getCcpIdentifier()
int	getConditionalProcessingRCDPointer()
int	getDataLength()
int	getDataStartPosition()
int	getEndSpace()
byte	getFieldAllignment()
int	getFieldDelimiter()
int	getFieldNumber()
int	getFieldRCDPointer()
java.util.EnumSet<RCD_RecordDescriptor.RCD_Flag>	getFlags()
AFPOrientation	getInlineOrientation()
int	getInlinePosition()
short	getPrimaryFontLocalId()
java.lang.String	getRecordDescriptorID()
RCD_XMD_RecordTypeElementType	getRecordType()
byte	getReserved14()
byte[]	getReserved57_69()
short	getShiftOutFontLocalID()
int	getStartingPageNumber()
byte	getSubpageID()
java.lang.String	getSuppressionTokenName()
void	setAdditionalBaselineIncrement(int additionalBaselineIncrement)
void	setBaselineOrientation(AFPOrientation baselineOrientation)
void	setBaselinePosition(int baselinePosition)
void	setCcpIdentifier(int ccpIdentifier)
void	setConditionalProcessingRCDPointer(int conditionalProcessingRCDPointer)
void	setDataLength(int dataLength)
void	setDataStartPosition(int dataStartPosition)
void	setEndSpace(int endSpace)
void	setFieldAllignment(byte fieldAllignment)
void	setFieldDelimiter(int fieldDelimiter)
void	setFieldNumber(int fieldNumber)
void	setFieldRCDPointer(int fieldRCDPointer)
void	setFlags(java.util.EnumSet<RCD_RecordDescriptor.RCD_Flag> flags)
void	setInlineOrientation(AFPOrientation inlineOrientation)
void	setInlinePosition(int inlinePosition)
void	setPrimaryFontLocalId(short primaryFontLocalId)
void	setRecordDescriptorID(java.lang.String recordDescriptorID)
void	setRecordType(RCD_XMD_RecordTypeElementType recordType)
void	setReserved14(byte reserved14)
void	setReserved57_69(byte[] reserved57_69)
void	setShiftOutFontLocalID(short shiftOutFontLocalID)
void	setStartingPageNumber(int startingPageNumber)
void	setSubpageID(byte subpageID)
void	setSuppressionTokenName(java.lang.String suppressionTokenName)
void	writeAFP(java.io.OutputStream os, AFPParserConfiguration config) Writes the object to the given os encoded as AFP data.

Methods inherited from class com.mgz.afp.base.StructuredFieldBaseTriplets

addTriplet, getTriplets, removeTriplet, setTriplets

Methods inherited from class com.mgz.afp.base.StructuredField

checkDataLength, getActualLength, getPadding, getStructuredFieldIntroducer, isBeginSF, isEndSF, isShallow, setPadding, setStructuredFieldIntroducer, toString, writeFullStructuredField

Methods inherited from class java.lang.Object

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

Constructor Detail

RCD_RecordDescriptor

public RCD_RecordDescriptor()

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

Overrides:

decodeAFP in class StructuredFieldBaseTriplets

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

Overrides:

writeAFP in class StructuredFieldBaseTriplets

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.

getRecordDescriptorID

public java.lang.String getRecordDescriptorID()

setRecordDescriptorID

public void setRecordDescriptorID(java.lang.String recordDescriptorID)

getRecordType

public RCD_XMD_RecordTypeElementType getRecordType()

setRecordType

public void setRecordType(RCD_XMD_RecordTypeElementType recordType)

getFlags

public java.util.EnumSet<RCD_RecordDescriptor.RCD_Flag> getFlags()

setFlags

public void setFlags(java.util.EnumSet<RCD_RecordDescriptor.RCD_Flag> flags)

getReserved14

public byte getReserved14()

setReserved14

public void setReserved14(byte reserved14)

getInlinePosition

public int getInlinePosition()

setInlinePosition

public void setInlinePosition(int inlinePosition)

getBaselinePosition

public int getBaselinePosition()

setBaselinePosition

public void setBaselinePosition(int baselinePosition)

getInlineOrientation

public AFPOrientation getInlineOrientation()

setInlineOrientation

public void setInlineOrientation(AFPOrientation inlineOrientation)

getBaselineOrientation

public AFPOrientation getBaselineOrientation()

setBaselineOrientation

public void setBaselineOrientation(AFPOrientation baselineOrientation)

getPrimaryFontLocalId

public short getPrimaryFontLocalId()

setPrimaryFontLocalId

public void setPrimaryFontLocalId(short primaryFontLocalId)

getFieldRCDPointer

public int getFieldRCDPointer()

setFieldRCDPointer

public void setFieldRCDPointer(int fieldRCDPointer)

getSuppressionTokenName

public java.lang.String getSuppressionTokenName()

setSuppressionTokenName

public void setSuppressionTokenName(java.lang.String suppressionTokenName)

getShiftOutFontLocalID

public short getShiftOutFontLocalID()

setShiftOutFontLocalID

public void setShiftOutFontLocalID(short shiftOutFontLocalID)

getDataStartPosition

public int getDataStartPosition()

setDataStartPosition

public void setDataStartPosition(int dataStartPosition)

getDataLength

public int getDataLength()

setDataLength

public void setDataLength(int dataLength)

getConditionalProcessingRCDPointer

public int getConditionalProcessingRCDPointer()

setConditionalProcessingRCDPointer

public void setConditionalProcessingRCDPointer(int conditionalProcessingRCDPointer)

getSubpageID

public byte getSubpageID()

setSubpageID

public void setSubpageID(byte subpageID)

getCcpIdentifier

public int getCcpIdentifier()

setCcpIdentifier

public void setCcpIdentifier(int ccpIdentifier)

getStartingPageNumber

public int getStartingPageNumber()

setStartingPageNumber

public void setStartingPageNumber(int startingPageNumber)

getEndSpace

public int getEndSpace()

setEndSpace

public void setEndSpace(int endSpace)

getFieldAllignment

public byte getFieldAllignment()

setFieldAllignment

public void setFieldAllignment(byte fieldAllignment)

getFieldDelimiter

public int getFieldDelimiter()

setFieldDelimiter

public void setFieldDelimiter(int fieldDelimiter)

getFieldNumber

public int getFieldNumber()

setFieldNumber

public void setFieldNumber(int fieldNumber)

getAdditionalBaselineIncrement

public int getAdditionalBaselineIncrement()

setAdditionalBaselineIncrement

public void setAdditionalBaselineIncrement(int additionalBaselineIncrement)

getReserved57_69

public byte[] getReserved57_69()

setReserved57_69

public void setReserved57_69(byte[] reserved57_69)