For use with Java applications generated by SoftwareMining's COBOL-to-Java conversion tools.

Package com.softwaremining.util

Class SortManager

java.lang.Object

com.softwaremining.util.SortManager

public class SortManager
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEBUG
protected static Log	log
static long	totalRuntime	for internal use only ...

Constructor Summary

Constructors

Constructor	Description
SortManager(CBLBean wrapper, AbstractCBLField newSortField)

Method Summary

Modifier and Type	Method	Description
void	addAll(List<String> values)	Append all elements to the sort
void	addKeyAscending(ISMObject field)
void	addKeyAscending(ISMObject[] fields)
void	addKeyAscending(String[] keyNames)
void	addKeyDescending(ISMObject field)
void	addKeyDescending(ISMObject[] fields)
void	addKeyDescending(String[] keyNames)
void	clear()	Clear all rows
String	get(int i)
List<String>	getAllRows()
List<OrderClause>	getKeys()
static int	getSortResult()
AbstractCBLField	getTopLevelSortField()
CBLBean	getWrapper()
void	insert()	automaticaly adds the stringified value of the sortFile (sortField was passed to SortManager constructor)
void	insert(String newValue)	Also add the new value to the sortField (sortField was passed to SortManager constructor)
boolean	isEof()	have we reached the end of the file ?
String	next()
String	nextRecord()
void	remove(int index)
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).
void	setSortField(ICBLDataType newSortField)
static void	setSortResult(int sortResult)
int	size()	have we reached the end of the file ?
int	sort()
int	sort(boolean onFailThrowException)
void	sortArray(AbstractCBLField arrayField)

Methods inherited from class java.lang.Object

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

Field Details

log

protected static transient Log log

DEBUG

public static final boolean DEBUG

See Also:

• Constant Field Values

totalRuntime

public static long totalRuntime

for internal use only ... profiling information

Constructor Details

SortManager

public SortManager(CBLBean wrapper,
 AbstractCBLField newSortField)

Method Details

getWrapper

public CBLBean getWrapper()

getKeys

public List<OrderClause> getKeys()

getTopLevelSortField

public AbstractCBLField getTopLevelSortField()

setSortField

public void setSortField(ICBLDataType newSortField)

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(ISMObject 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 -

sortArray

public void sortArray(AbstractCBLField arrayField)

sort

public int sort()

sort

public int sort(boolean onFailThrowException)

Returns:

int - 0 is success, 16 is failure designed to return a value indicating whether sort is successful or not. For documentation please see: http://publib.boulder.ibm.com/infocenter/iadthelp/v7r0/index.jsp?topic=/com.ibm.etools.iseries.langref.doc/c0925395446.htm It says: When used in nested programs, the SORT-RETURN special register is implicitly defined as GLOBAL in the outermost COBOL program. The SORT-RETURN special register contains a return code of 0 (successful) or 16 (unsuccessful) at the completion of a sort/merge operation. You can set the SORT-RETURN special register to 16 in an error declarative or input/output procedure to terminate a sort/merge operation before all records are processed. The operation is terminated before a record is RETURNed or RELEASEd. You may specify the SORT-RETURN special register in a function wherever an integer argument is allowed.

next

public String next()

nextRecord

public String 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

get

public String get(int i)

getAllRows

public List<String> getAllRows()

insert

public void insert()

automaticaly adds the stringified value of the sortFile (sortField was passed to SortManager constructor)

insert

public void insert(String newValue)

Also add the new value to the sortField (sortField was passed to SortManager constructor)

Parameters:

newValue -

addAll

public void addAll(List<String> values)

Append all elements to the sort

Parameters:

newValue -

clear

public void clear()

Clear all rows

Parameters:

newValue -

remove

public void remove(int index)

getSortResult

public static int getSortResult()

setSortResult

public static void setSortResult(int sortResult)