Package com.softwaremining.wrappers

Class AbstractSortBean

java.lang.Object

com.softwaremining.wrappers.CBLBean

com.softwaremining.wrappers.AbstractSortBean

All Implemented Interfaces:

AbstractDataObject, ICBLBeanNGroup, ICBLContainer, IFieldContainer, ISMBean, ISMDataType

public abstract class AbstractSortBean
extends CBLBean

Providing Sort Capabilities to DataBeans

Field Summary

Fields inherited from class com.softwaremining.wrappers.CBLBean

EBCDIC_JIT_PD_SUPPORT_FOR_SEQ_FILES, INDEX_FOR_NON_ARRAY_VERSION_OF_FIELD, INDEX_ZERO, log, tmp_lengthofAssignedValue, totalRuntime_allocate, totalRuntime_calcFieldOffsets, totalRuntime_getMemoryPosition, totalRuntime_setFieldFormatted

Constructor Summary

Constructors

Constructor	Description
AbstractSortBean()	for internal use only ...
AbstractSortBean(BaseService owner)

Method Summary

Modifier and Type	Method	Description
void	addKeyAscending(ISMObject field)
void	addKeyAscending(ISMObject[] fields)
void	addKeyAscending(String[] keyNames)
void	addKeyDescending(AbstractCBLField field)
void	addKeyDescending(ISMObject[] fields)
void	addKeyDescending(String[] keyNames)
void	assignSortModeSize(int size)	Deprecated. - not needed or supported
void	assignStatus(ISMObject status)
void	assignStatusValue(int value)	Used internally to set the IO operation status-values.
protected void	assignStatusValue(String value)	Method for assigning a string to the status.
void	insert()	insert a record into the to-be-sorted-list
boolean	isEof()	have we reached the end of the file ?
void	load(AbstractBasePersistence file)	load a file for Sort Operation
void	loadForMerge(AbstractBasePersistence file)	load a file for Merge operation
void	merge()	Merge two or more files (See COBOL's MERGE statement)
void	next()
void	nextRecord()
void	release()	The release statement transfers records from the INPUT PROCEDURE to the input Phase of the sort operation. Internally, it will call the InsertRecord() method for performing the transfer.
void	releaseRecord()	The release statement transfers records from the INPUT PROCEDURE to the input Phase of the sort operation. Internally, it will call the InsertRecord() method for performing the transfer. The "xxxRecord" is generated by the translator when it expect there may be an Exception.
abstract AbstractCBLField	retrieveFirstLevelEntry()
int	retrieveSortResult()
ISMObject	retrieveStatusField()	Used internally to set the IO operation status-values.
int	retrieveStatusValue()	Used internally to set the IO operation status-values.
void	save(AbstractSequentialFile file)
void	setAccessMode(int value)
void	setDuplicatesInOrder(boolean duplicatesInOrder)	Controls Sort of records with duplicate keys: Whether original order is maintained.
void	setEbcdicSort(boolean newValue)	===== WARNING ====>: Please note, DO NOT use when sorting Numeric VALUES In ASCII character '1' is before 'A', in EBCDIC it is the other way ('A' before '1') Setting EBCDIC Sort will convert all the values to EBCDIC before comparison (Hence lower performance).
int	size()	have we reached the end of the file ?
void	sort()	Sort data (See COBOL's SORT statement)

Methods inherited from class com.softwaremining.wrappers.CBLBean

addCorrespondingValue, addCorrespondingValue, allocate, assignAddressTo, assignAddressTo, assignBean, assignBytesEncoded, assignCachedInitializationValue, assignCorrespondingValue, assignCorrespondingValue, assignDefaultValue, assignDependingField, assignEbcdicBytes, assignEbcdicJIT_PdSupportForSequentialFiles, assignEncodedValue, assignExemptFromMemRelease, assignExternal, assignHighValues, assignInternalVars, assignLowValues, assignRawEbcdicBytes, assignRecordSize, assignRedefines, assignRedefines, assignSessionId, assignStringFormatted, assignSubstring, assignSubstring, assignToAddressOf, assignToAddressOf, assignToAddressOf, assignToAddressOf, assignToAllFields, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, assignValue, calculateStorageSize, containsPointers, equals, equals, equals, equals, equalsRightTrimmed, fieldsCount, fill, fill, fill, fill, fill, getValue, hasPackedDecimalFields, hasSameStorageManager, initDefaultValues, initialize, initialize, isExemptFromMemRelease, isFilled, isFilled, isFilled, isFilled, isGreaterThan, isGreaterThan, isGreaterThan, isHighValues, isInvolvedInDependency, isInvolvedInExternalDependency, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessOrEqualTo, isLessThan, isLessThan, isLessThan, isLessThan, isLessThan, isLowValues, isRedefinedByAnotherClass, isResourceAlreadyReleased, lengthOf, print, printFieldPosition, printFieldValues, printOrderedFieldPosition, releaseResources, releaseResources, resetCachedValues, resetCompressedFieldList, resetStorageManager, resetStructure, resize, retrieveActualLength, retrieveAsInt, retrieveAsString, retrieveCachedInitializationValue, retrieveCompressedFields, retrieveDependedFieldsList, retrieveEbcdicBytes, retrieveEbcdicValue, retrieveEncodedValue, retrieveField, retrieveField, retrieveFieldAtMemoryPosition, retrieveFieldFormatted, retrieveFields, retrieveIsTargetOfPointers, retrievePrimitiveFields, retrieveRawEbcdicBytes, retrieveRedefinesList, retrieveSessionId, retrieveSQLObject, retrieveStorageBytes, retrieveStorageCellSize, retrieveSubstring, retrieveSubstring, retrieveTopLevelField, retrieveValue, retrieveValue, setValue, stringValue, subtractCorrespondingValue, subtractCorrespondingValue, toString

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractSortBean

public AbstractSortBean()

for internal use only ... profiling information

AbstractSortBean

public AbstractSortBean(BaseService owner)

Method Details

retrieveFirstLevelEntry

public abstract AbstractCBLField retrieveFirstLevelEntry()

setAccessMode

public void setAccessMode(int value)

setDuplicatesInOrder

public void setDuplicatesInOrder(boolean duplicatesInOrder)

Controls Sort of records with duplicate keys: Whether original order is maintained. Defaults is to true

Parameters:

duplicatesInOrder -

addKeyAscending

public void addKeyAscending(ISMObject field)

addKeyAscending

public void addKeyAscending(String[] keyNames)

addKeyDescending

public void addKeyDescending(String[] keyNames)

addKeyAscending

public void addKeyAscending(ISMObject[] fields)

addKeyDescending

public void addKeyDescending(ISMObject[] fields)

addKeyDescending

public void addKeyDescending(AbstractCBLField field)

setEbcdicSort

public void setEbcdicSort(boolean newValue)

===== WARNING ====>: Please note, DO NOT use when sorting Numeric VALUES In ASCII character '1' is before 'A', in EBCDIC it is the other way ('A' before '1') Setting EBCDIC Sort will convert all the values to EBCDIC before comparison (Hence lower performance).

Parameters:

newValue -

next

public void next()

nextRecord

public void nextRecord()
                throws AtEndException,
IOStatusException

Throws:

AtEndException

IOStatusException

isEof

public boolean isEof()
              throws CBLException

have we reached the end of the file ?

Returns:

Throws:

CBLException

size

public int size()

have we reached the end of the file ?

Returns:

Throws:

CBLException

release

public void release()

The release statement transfers records from the INPUT PROCEDURE to the input Phase of the sort operation.
Internally, it will call the InsertRecord() method for performing the transfer.

releaseRecord

public void releaseRecord()

The release statement transfers records from the INPUT PROCEDURE to the input Phase of the sort operation.
Internally, it will call the InsertRecord() method for performing the transfer.
The "xxxRecord" is generated by the translator when it expect there may be an Exception. In this case, it doesn't apply. The method is here merely to provide consistency with Translator

sort

public void sort()

Sort data (See COBOL's SORT statement)

merge

public void merge()

Merge two or more files (See COBOL's MERGE statement)

insert

public void insert()

insert a record into the to-be-sorted-list

assignStatus

public void assignStatus(ISMObject status)

assignStatusValue

public void assignStatusValue(int value)

Used internally to set the IO operation status-values. Also if a FileStatus field is defined, the system will allocate correct values to it.

Parameters:

value - - .. one of ACMBasePersistent.STATUS_xxxx

assignStatusValue

protected void assignStatusValue(String value)

Method for assigning a string to the status. Note that in MicroFOcus, the LOCK status is represented bt "9D", ie the 2nd value is a String

Parameters:

value -

retrieveStatusValue

public int retrieveStatusValue()

Used internally to set the IO operation status-values. Also if a FileStatus field is defined, the system will allocate correct values to it.

Returns:

- the status value .. one of ACMBasePersistent.STATUS_xxxx

retrieveSortResult

public int retrieveSortResult()

retrieveStatusField

public ISMObject retrieveStatusField()

Used internally to set the IO operation status-values.

assignSortModeSize

public void assignSortModeSize(int size)

Deprecated.

- not needed or supported

loadForMerge

public void loadForMerge(AbstractBasePersistence file)
                  throws CBLException

load a file for Merge operation

Parameters:

file -

Throws:

CBLException

load

public void load(AbstractBasePersistence file)
          throws CBLException

load a file for Sort Operation

Parameters:

file -

Throws:

CBLException

save

public void save(AbstractSequentialFile file)
          throws CBLException

Throws:

CBLException