com.mgz.afp.lineData

Class BDM_BeginDataMap

java.lang.Object

com.mgz.afp.base.StructuredField

com.mgz.afp.base.StructuredFieldBaseTriplets

com.mgz.afp.lineData.BDM_BeginDataMap

All Implemented Interfaces:

IHasName, IHasTriplets, IAFPDecodeableWriteable

public class BDM_BeginDataMap
extends StructuredFieldBaseTriplets
implements IHasName

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

The Begin Data Map structured field begins a Data Map resource object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BDM_BeginDataMap.BDM_DataFormat Format of the data map of BDM_BeginDataMap

Field Summary

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

triplets

Constructor Summary

Constructors

Constructor and Description
BDM_BeginDataMap()

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.
BDM_BeginDataMap.BDM_DataFormat	getDataFormat() Returns the data format specified by this Data Map.
java.lang.String	getName() Returns the name.
void	setDataFormat(BDM_BeginDataMap.BDM_DataFormat dataFormat) Sets the data format specified by this BDM_BeginDataMap.
void	setName(java.lang.String dataMapName) Sets the name.
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

BDM_BeginDataMap

public BDM_BeginDataMap()

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.

getName

public java.lang.String getName()

Description copied from interface: IHasName

Returns the name.

Specified by:

getName in interface IHasName

Returns:

name of this structured field.

setName

public void setName(java.lang.String dataMapName)

Description copied from interface: IHasName

Sets the name.

Specified by:

setName in interface IHasName

Parameters:

dataMapName - the name of this structured field

getDataFormat

public BDM_BeginDataMap.BDM_DataFormat getDataFormat()

Returns the data format specified by this Data Map.

Returns:

data format specified by this Data Map.

setDataFormat

public void setDataFormat(BDM_BeginDataMap.BDM_DataFormat dataFormat)

Sets the data format specified by this BDM_BeginDataMap.

Parameters:

dataFormat - data format specified by this BDM_BeginDataMap