com.legstar.base.finder

Class CobolComplexTypeFinder

java.lang.Object

com.legstar.base.finder.CobolTypeFinder

com.legstar.base.finder.CobolComplexTypeFinder

Direct Known Subclasses:

RdwCobolComplexTypeFinder

public class CobolComplexTypeFinder
extends CobolTypeFinder

This finder implementation assumes a complex type starts with a number of fields that have recognizable formats and boundaries. All together these fields form the Type's signature.

This finder is constructed using a Cobol complex type and a stop field which delimits the number of fields at the start of the complex type forming the type's 'signature'.

Note that some Cobol types are easier to recognize than others, for instance CobolPackedDecimalType and CobolZonedDecimalType impose severe limitations on their content and therefore are unlikely to be missed for some other type. So you want to have as many as possible of these in your signature.

Decimal types can be defined with boundaries (minInclusive and maxInclusive) which are very useful to avoid the risk of a mismatch.

Note that this implementation will not work if the signature part of the type contains variable size arrays (DEPENDING ON) or choices (REDEFINES).

Constructor Summary

Constructors

Constructor and Description
CobolComplexTypeFinder(CobolContext cobolContext, CobolComplexType cobolComplexType) Construct the finder.
CobolComplexTypeFinder(CobolContext cobolContext, CobolComplexType cobolComplexType, String stopFieldInclusive) Construct the finder.

Method Summary

Modifier and Type	Method and Description
CobolComplexType	getCobolComplexType()
long	getMaxBytesLen()
long	getMinBytesLen()
int	getSignatureLen()
String	getStopFieldInclusive()
boolean	match(byte[] hostData, int start, int length) Match a Cobol type to an incoming host bytes set.

Methods inherited from class com.legstar.base.finder.CobolTypeFinder

indexOf

Methods inherited from class java.lang.Object

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

Constructor Detail

CobolComplexTypeFinder

public CobolComplexTypeFinder(CobolContext cobolContext,
                              CobolComplexType cobolComplexType)

Construct the finder.

Parameters:

cobolContext - host COBOL configuration parameters

cobolComplexType - the Cobol complex type we are looking for

CobolComplexTypeFinder

public CobolComplexTypeFinder(CobolContext cobolContext,
                              CobolComplexType cobolComplexType,
                              String stopFieldInclusive)

Construct the finder.

Parameters:

cobolContext - host COBOL configuration parameters

cobolComplexType - the Cobol complex type we are looking for

stopFieldInclusive - what is the last field of the signature (the signature is formed by all fields from the start of the complex type up to this one). If you pass null or a field that is not in the complex type, the entire complex type form the signature.

Method Detail

match

public boolean match(byte[] hostData,
                     int start,
                     int length)

Match a Cobol type to an incoming host bytes set.

Specified by:

match in class CobolTypeFinder

Parameters:

hostData - the host bytes set

start - where to start matching

length - the size of the incoming host bytes set. This should be large enough to hold a signature but is not guaranteed to hold more than that.

Returns:

true if the Cobol type is compatible with the host bytes at the given start position

getSignatureLen

public int getSignatureLen()

Specified by:

getSignatureLen in class CobolTypeFinder

Returns:

the byte length of the signature (total number of bytes needed to match the type)

getCobolComplexType

public CobolComplexType getCobolComplexType()

getStopFieldInclusive

public String getStopFieldInclusive()

getMinBytesLen

public long getMinBytesLen()

getMaxBytesLen

public long getMaxBytesLen()