com.mgz.afp.lineData

Class CCP_ConditionalProcessingControl

java.lang.Object

com.mgz.afp.base.StructuredField

com.mgz.afp.lineData.CCP_ConditionalProcessingControl

All Implemented Interfaces:

IAFPDecodeableWriteable

public class CCP_ConditionalProcessingControl
extends StructuredField

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

The Conditional Processing Control structured field defines tests to be performed on selected input records in line data and specifies the actions to take based on the test results. This optional structured field is selected with LND, RCD or XMD structured fields in the Page Definition. An LND, RCD or XMD can have a unique CCP associated with it or it can reference a CCP that has already been used. In either case, the CCP is referenced with the CCPID field of the LND, RCD or XMD. If a CCP structured field is included in a Page Definition, it must appear before the Data Maps in the Page Definition.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CCP_ConditionalProcessingControl.CCP_Flag
static class	CCP_ConditionalProcessingControl.CCP_RepeatingGroup Programming Guide and Line Data Reference (ha3l3r04.pdf), page 84 Each repeating group of the CCP contains action information.

Constructor Summary

Constructors

Constructor and Description
CCP_ConditionalProcessingControl()

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	getCcpIdentifier()
CCP_ConditionalProcessingControl.CCP_Flag	getFlag()
int	getLengthOfComparisonString()
int	getLengthOfRepeatingGroup()
int	getNextCcpIdentifier()
int	getNumberOfRepeatingGroups()
java.util.List<CCP_ConditionalProcessingControl.CCP_RepeatingGroup>	getRepeatingGroups()
byte	getReserved5()
void	setCcpIdentifier(int ccpIdentifier)
void	setFlag(CCP_ConditionalProcessingControl.CCP_Flag flag)
void	setLengthOfComparisonString(int lengthOfComparisonString)
void	setLengthOfRepeatingGroup(int lengthOfRepeatingGroup)
void	setNextCcpIdentifier(int nextCcpIdentifier)
void	setNumberOfRepeatingGroups(int numberOfRepeatingGroups)
void	setRepeatingGroups(java.util.List<CCP_ConditionalProcessingControl.CCP_RepeatingGroup> repeatingGroups)
void	setReserved5(byte reserved5)
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

Constructor Detail

CCP_ConditionalProcessingControl

public CCP_ConditionalProcessingControl()

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.

getCcpIdentifier

public int getCcpIdentifier()

setCcpIdentifier

public void setCcpIdentifier(int ccpIdentifier)

getNextCcpIdentifier

public int getNextCcpIdentifier()

setNextCcpIdentifier

public void setNextCcpIdentifier(int nextCcpIdentifier)

getFlag

public CCP_ConditionalProcessingControl.CCP_Flag getFlag()

setFlag

public void setFlag(CCP_ConditionalProcessingControl.CCP_Flag flag)

getReserved5

public byte getReserved5()

setReserved5

public void setReserved5(byte reserved5)

getNumberOfRepeatingGroups

public int getNumberOfRepeatingGroups()

setNumberOfRepeatingGroups

public void setNumberOfRepeatingGroups(int numberOfRepeatingGroups)

getLengthOfRepeatingGroup

public int getLengthOfRepeatingGroup()

setLengthOfRepeatingGroup

public void setLengthOfRepeatingGroup(int lengthOfRepeatingGroup)

getLengthOfComparisonString

public int getLengthOfComparisonString()

setLengthOfComparisonString

public void setLengthOfComparisonString(int lengthOfComparisonString)

getRepeatingGroups

public java.util.List<CCP_ConditionalProcessingControl.CCP_RepeatingGroup> getRepeatingGroups()

setRepeatingGroups

public void setRepeatingGroups(java.util.List<CCP_ConditionalProcessingControl.CCP_RepeatingGroup> repeatingGroups)