com.legstar.base.visitor

Class FromCobolVisitor

java.lang.Object

com.legstar.base.visitor.FromCobolVisitor

All Implemented Interfaces:

CobolVisitor

Direct Known Subclasses:

Cob2ObjectValidator, Cob2ObjectVisitor

public abstract class FromCobolVisitor
extends Object
implements CobolVisitor

Generic visitor using mainframe data as input and producing some kind of output (up to the specialized classes).

Mainframe data is expected as a byte array.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FromCobolVisitor.ArrayTypeItemHandler Notifies specialized implementations when an array's item has been visited.
static interface	FromCobolVisitor.ChoiceTypeAlternativeHandler Notifies specialized implementations when an alternative has been selected and visited
static interface	FromCobolVisitor.ComplexTypeChildHandler Notifies specialized implementations when a complex type child has been visited.
static interface	FromCobolVisitor.PrimitiveTypeHandler Notifies specialized implementations when a primitive type has been visited (and hence its value is known).

Constructor Summary

Constructors

Constructor and Description
FromCobolVisitor(CobolContext cobolContext, byte[] hostData, int start, int length)
FromCobolVisitor(CobolContext cobolContext, byte[] hostData, int start, int length, FromCobolChoiceStrategy customChoiceStrategy)
FromCobolVisitor(CobolContext cobolContext, byte[] hostData, int start, int length, FromCobolChoiceStrategy customChoiceStrategy, Set<String> customVariables)

Method Summary

Modifier and Type	Method and Description
CobolContext	getCobolContext()
String	getCurFieldFullCobolName()
String	getCurFieldName() Field being visited.
byte[]	getHostData() Incoming mainframe data.
int	getLastPos() After the visitor is done visiting, this will contain the last position in the incoming mainframe data buffer that was processed.
int	getLength() How many bytes of hostData contains actual data to process.
int	getStart() Where to start processing in the incoming mainframe data buffer.
Map<String,Object>	getVariables() The set of custom variables and ODOObjects collected while visiting.
boolean	isCustomVariable(CobolPrimitiveType<?> type, String name) A primitive type is a custom variable if it has been marked as so via one of the available mechanisms or is needed to make choice decisions.
void	putVariable(String name, Object value) Keep track of a variable's value
void	setLastPos(int lastPos) Specialized implementations might need to advance the last position.
void	visitCobolArrayType(CobolArrayType type, FromCobolVisitor.ArrayTypeItemHandler callback) Visit an array type which visits each items in turn.
void	visitCobolChoiceType(CobolChoiceType choiceType, FromCobolVisitor.ChoiceTypeAlternativeHandler callback) Visit a choice type (COBOL REDEFINES) which determines which alternative must be selected.
void	visitCobolPrimitiveType(CobolPrimitiveType<?> type, FromCobolVisitor.PrimitiveTypeHandler callback) Visit a primitive type performing the actual conversion to a java object.
void	visitComplexType(CobolComplexType type, FromCobolVisitor.ComplexTypeChildHandler callback) Visit a complex type which visits each of its children in turn.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.legstar.base.visitor.CobolVisitor

visit, visit, visit, visit

Constructor Detail

FromCobolVisitor

public FromCobolVisitor(CobolContext cobolContext,
                        byte[] hostData,
                        int start,
                        int length)

FromCobolVisitor

public FromCobolVisitor(CobolContext cobolContext,
                        byte[] hostData,
                        int start,
                        int length,
                        FromCobolChoiceStrategy customChoiceStrategy)

FromCobolVisitor

public FromCobolVisitor(CobolContext cobolContext,
                        byte[] hostData,
                        int start,
                        int length,
                        FromCobolChoiceStrategy customChoiceStrategy,
                        Set<String> customVariables)

Method Detail

visitComplexType

public void visitComplexType(CobolComplexType type,
                             FromCobolVisitor.ComplexTypeChildHandler callback)

Visit a complex type which visits each of its children in turn.

Optional children may be skipped.

Parameters:

type - the complex type to visit

callback - a function that is invoked for each child in turn after it has been visited

visitCobolArrayType

public void visitCobolArrayType(CobolArrayType type,
                                FromCobolVisitor.ArrayTypeItemHandler callback)

Visit an array type which visits each items in turn.

Size of the array might be inferred from an ODOObject visited before this array.

Parameters:

type - the array's item type

callback - a function that is invoked for each item in turn after it has been visited

visitCobolChoiceType

public void visitCobolChoiceType(CobolChoiceType choiceType,
                                 FromCobolVisitor.ChoiceTypeAlternativeHandler callback)

Visit a choice type (COBOL REDEFINES) which determines which alternative must be selected.

Parameters:

choiceType - the choice type

callback - a function that is invoked after the selected alternative has been visited

visitCobolPrimitiveType

public void visitCobolPrimitiveType(CobolPrimitiveType<?> type,
                                    FromCobolVisitor.PrimitiveTypeHandler callback)
                             throws FromCobolException

Visit a primitive type performing the actual conversion to a java object.

If there is an extra offset left over by a previous item, adjust the position accordingly.

Parameters:

type - the primitive type

callback - a function that is invoked after the primitive type has been visited

Throws:

FromCobolException - conversion failure

getHostData

public byte[] getHostData()

Incoming mainframe data.

Returns:

Incoming mainframe data

getStart

public int getStart()

Where to start processing in the incoming mainframe data buffer.

Returns:

Where to start processing in the incoming mainframe data buffer

getLength

public int getLength()

How many bytes of hostData contains actual data to process.

Returns:

How many bytes of hostData contains actual data to process

getLastPos

public int getLastPos()

After the visitor is done visiting, this will contain the last position in the incoming mainframe data buffer that was processed.

Returns:

last position in the incoming mainframe data buffer that was processed

setLastPos

public void setLastPos(int lastPos)

Specialized implementations might need to advance the last position.

Parameters:

lastPos - last position in the incoming mainframe byte array

putVariable

public void putVariable(String name,
                        Object value)

Keep track of a variable's value

Parameters:

name - the variable name

value - the variable value

getVariables

public Map<String,Object> getVariables()

The set of custom variables and ODOObjects collected while visiting.

Returns:

a map of variable names to their values

isCustomVariable

public boolean isCustomVariable(CobolPrimitiveType<?> type,
                                String name)

A primitive type is a custom variable if it has been marked as so via one of the available mechanisms or is needed to make choice decisions.

Parameters:

type - the primitive type

name - the variable name

Returns:

true if this is a custom variable

getCurFieldName

public String getCurFieldName()

Field being visited. The name identifies this field to its immediate parent.

Returns:

name of field being visited

getCurFieldFullCobolName

public String getCurFieldFullCobolName()

Returns:

the name of the current field with ancestor path

getCobolContext

public CobolContext getCobolContext()