com.mgz.afp.foca

Class CPD_CodePageDescriptor

java.lang.Object

com.mgz.afp.base.StructuredField

com.mgz.afp.foca.CPD_CodePageDescriptor

All Implemented Interfaces:

IAFPDecodeableWriteable

public class CPD_CodePageDescriptor
extends StructuredField

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CPD_CodePageDescriptor.EncodingScheme

Field Summary

Fields

Modifier and Type	Field and Description
short	graphicCharacterGIDLength This is the length of the IBM registered GCGID (AFP uses the eight-character identifier format), or a user-assigned GCGID.

Constructor Summary

Constructors

Constructor and Description
CPD_CodePageDescriptor()

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.
java.lang.String	getCodePageDescription()
int	getCodePageGID()
CPD_CodePageDescriptor.EncodingScheme	getEncodingScheme()
short	getGraphicCharacterGIDLength()
int	getGraphicCharacterSetGID()
long	getNumberOfCodedGraphicCharactersAssigned()
void	setCodePageDescription(java.lang.String codePageDescription)
void	setCodePageGID(int codePageGID)
void	setEncodingScheme(CPD_CodePageDescriptor.EncodingScheme encodingScheme)
void	setGraphicCharacterGIDLength(short graphicCharacterGIDLength)
void	setGraphicCharacterSetGID(int graphicCharacterSetGID)
void	setNumberOfCodedGraphicCharactersAssigned(long numberOfCodedGraphicCharactersAssigned)
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.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

Field Detail

graphicCharacterGIDLength

public short graphicCharacterGIDLength

This is the length of the IBM registered GCGID (AFP uses the eight-character identifier format), or a user-assigned GCGID.

Constructor Detail

CPD_CodePageDescriptor

public CPD_CodePageDescriptor()

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

Specified by:

decodeAFP in class StructuredField

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

Specified by:

writeAFP in class StructuredField

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.

getCodePageDescription

public java.lang.String getCodePageDescription()

setCodePageDescription

public void setCodePageDescription(java.lang.String codePageDescription)

getGraphicCharacterGIDLength

public short getGraphicCharacterGIDLength()

setGraphicCharacterGIDLength

public void setGraphicCharacterGIDLength(short graphicCharacterGIDLength)

getNumberOfCodedGraphicCharactersAssigned

public long getNumberOfCodedGraphicCharactersAssigned()

setNumberOfCodedGraphicCharactersAssigned

public void setNumberOfCodedGraphicCharactersAssigned(long numberOfCodedGraphicCharactersAssigned)

getGraphicCharacterSetGID

public int getGraphicCharacterSetGID()

setGraphicCharacterSetGID

public void setGraphicCharacterSetGID(int graphicCharacterSetGID)

getCodePageGID

public int getCodePageGID()

setCodePageGID

public void setCodePageGID(int codePageGID)

getEncodingScheme

public CPD_CodePageDescriptor.EncodingScheme getEncodingScheme()

setEncodingScheme

public void setEncodingScheme(CPD_CodePageDescriptor.EncodingScheme encodingScheme)