Module org.eclipse.persistence.nosql

Package org.eclipse.persistence.internal.eis.cobol

Class CompositeFieldMetaData

java.lang.Object

org.eclipse.persistence.internal.eis.cobol.ElementaryFieldMetaData

org.eclipse.persistence.internal.eis.cobol.CompositeFieldMetaData

All Implemented Interfaces:

CompositeObject, FieldMetaData

public class CompositeFieldMetaData
extends ElementaryFieldMetaData
implements CompositeObject

Purpose: This class represents metadata for composite fields. It exetends ElementaryFieldMetaData and adds teh attribute myCompositeFields which is a collection of subordinate fields.

Field Summary

Fields

Modifier and Type	Field	Description
protected Vector<FieldMetaData>	myCompositeFields	collection containing this fields subordinate fields

Fields inherited from class org.eclipse.persistence.internal.eis.cobol.ElementaryFieldMetaData

decimalPosition, isRedefine, isSigned, myArraySize, myDependentFieldName, myFieldRedefined, myName, myOffset, myRecord, mySize, myType

Fields inherited from interface org.eclipse.persistence.internal.eis.cobol.FieldMetaData

ALPHA_NUMERIC, ALPHABETIC, BINARY, COMPOSITE, MANTISSA, NUMERIC, PACKED_DECIMAL, VOID

Constructor Summary

Constructors

Constructor	Description
CompositeFieldMetaData()
CompositeFieldMetaData(String fieldName, String recordName)
CompositeFieldMetaData(String fieldName, RecordMetaData record)
CompositeFieldMetaData(String fieldName, RecordMetaData record, Vector<FieldMetaData> fields)

Method Summary

Modifier and Type	Method	Description
void	addField(FieldMetaData newField)	adds a field to the collection
FieldMetaData	deepCopy()	performs a deep copy of all subordiate fields in the myCompositeFields attribute
Object	extractValueFromArray(byte[] recordData)	loops through the subordinate fields extracting the value from each.
int	getDecimalPosition()	a composite field can't have a decimal position
FieldMetaData	getFieldNamed(String fieldName)	returns the first subordinate field with a name matching the string in fieldName
Vector<FieldMetaData>	getFields()	returns a collection of subordinate fields
int	getSize()	overides ElementaryFieldMetaData to calculate the fields size from all the sizes of its subordinate fields.
int	getType()	a composite field is by definition going to be composite
boolean	hasDecimal()	a composite field can't have a decimal position
protected void	initialize()
protected void	initialize(Vector<FieldMetaData> fields)
boolean	isComposite()	a composite field is by definition going to be composite
protected void	resetChildOffsets()	method resets offsets of subordinate fields, should be called when the offset of the parent is changed.
void	setDecimalPosition()	a composite field can't have a decimal position
void	setFields(Vector<FieldMetaData> newCompositeFields)	sets the composite field attribute to the new collection
void	setSize(int size)	we don't want to set the size for a composite field because its size is determined from its subordinate fields.
void	setType(int type)	a composite field is by definition going to be composite, so this cannot be changed
protected void	writeCompositeOnArray(CobolRow row, byte[] recordData)	This method is used by fields that are array values to write themselves to arrays
void	writeCompositeOnRow(CobolRow row, byte[] recordData)	writes individual fields on given row
void	writeOnArray(CobolRow row, byte[] recordData)	takes the value from the row for this field and writes it to the byte array
void	writeOnRow(CobolRow row, byte[] recordData)	extracts the value from the record data for the field and writes it to the row.

Methods inherited from class org.eclipse.persistence.internal.eis.cobol.ElementaryFieldMetaData

adjustArraySize, dependsOn, getArraySize, getCompositeFields, getDependentFieldName, getFieldRedefined, getName, getOffset, getRecord, initialize, initialize, isArray, isFieldRedefine, isSigned, setArraySize, setDecimalPosition, setDependentFieldName, setFieldRedefined, setIsFieldRedefine, setIsSigned, setName, setOffset, setRecord

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.persistence.internal.eis.cobol.CompositeObject

getName

Field Details

myCompositeFields

protected Vector<FieldMetaData> myCompositeFields

collection containing this fields subordinate fields

Constructor Details

CompositeFieldMetaData

public CompositeFieldMetaData()

CompositeFieldMetaData

public CompositeFieldMetaData(String fieldName,
 String recordName)

CompositeFieldMetaData

public CompositeFieldMetaData(String fieldName,
 RecordMetaData record)

CompositeFieldMetaData

public CompositeFieldMetaData(String fieldName,
 RecordMetaData record,
 Vector<FieldMetaData> fields)

Method Details

initialize

protected void initialize()

Overrides:

initialize in class ElementaryFieldMetaData

initialize

protected void initialize(Vector<FieldMetaData> fields)

deepCopy

public FieldMetaData deepCopy()

performs a deep copy of all subordiate fields in the myCompositeFields attribute

Specified by:

deepCopy in interface FieldMetaData

Overrides:

deepCopy in class ElementaryFieldMetaData

getSize

public int getSize()

overides ElementaryFieldMetaData to calculate the fields size from all the sizes of its subordinate fields.

Specified by:

getSize in interface FieldMetaData

Overrides:

getSize in class ElementaryFieldMetaData

setSize

public void setSize(int size)

we don't want to set the size for a composite field because its size is determined from its subordinate fields.

Specified by:

setSize in interface FieldMetaData

Overrides:

setSize in class ElementaryFieldMetaData

hasDecimal

public boolean hasDecimal()

a composite field can't have a decimal position

Specified by:

hasDecimal in interface FieldMetaData

Overrides:

hasDecimal in class ElementaryFieldMetaData

getDecimalPosition

public int getDecimalPosition()

a composite field can't have a decimal position

Specified by:

getDecimalPosition in interface FieldMetaData

Overrides:

getDecimalPosition in class ElementaryFieldMetaData

setDecimalPosition

public void setDecimalPosition()

a composite field can't have a decimal position

isComposite

public boolean isComposite()

a composite field is by definition going to be composite

Specified by:

isComposite in interface FieldMetaData

Overrides:

isComposite in class ElementaryFieldMetaData

getType

public int getType()

a composite field is by definition going to be composite

Specified by:

getType in interface FieldMetaData

Overrides:

getType in class ElementaryFieldMetaData

setType

public void setType(int type)

a composite field is by definition going to be composite, so this cannot be changed

Specified by:

setType in interface FieldMetaData

Overrides:

setType in class ElementaryFieldMetaData

getFields

public Vector<FieldMetaData> getFields()

returns a collection of subordinate fields

Specified by:

getFields in interface CompositeObject

setFields

public void setFields(Vector<FieldMetaData> newCompositeFields)

sets the composite field attribute to the new collection

Specified by:

setFields in interface CompositeObject

addField

public void addField(FieldMetaData newField)

adds a field to the collection

Specified by:

addField in interface CompositeObject

getFieldNamed

public FieldMetaData getFieldNamed(String fieldName)

returns the first subordinate field with a name matching the string in fieldName

Specified by:

getFieldNamed in interface CompositeObject

extractValueFromArray

public Object extractValueFromArray(byte[] recordData)

loops through the subordinate fields extracting the value from each.

Specified by:

extractValueFromArray in interface FieldMetaData

Overrides:

extractValueFromArray in class ElementaryFieldMetaData

writeCompositeOnRow

public void writeCompositeOnRow(CobolRow row,
 byte[] recordData)

writes individual fields on given row

writeOnRow

public void writeOnRow(CobolRow row,
 byte[] recordData)

extracts the value from the record data for the field and writes it to the row.

Specified by:

writeOnRow in interface FieldMetaData

Overrides:

writeOnRow in class ElementaryFieldMetaData

writeOnArray

public void writeOnArray(CobolRow row,
 byte[] recordData)

takes the value from the row for this field and writes it to the byte array

Specified by:

writeOnArray in interface FieldMetaData

Overrides:

writeOnArray in class ElementaryFieldMetaData

writeCompositeOnArray

protected void writeCompositeOnArray(CobolRow row,
 byte[] recordData)

This method is used by fields that are array values to write themselves to arrays

resetChildOffsets

protected void resetChildOffsets()

method resets offsets of subordinate fields, should be called when the offset of the parent is changed.