com.ontimize.db
Class AdvancedEntityResult

java.lang.Object
  java.util.Dictionary
      java.util.Hashtable
          com.ontimize.db.EntityResult
              com.ontimize.db.AdvancedEntityResult

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map, java.io.Serializable

public class AdvancedEntityResult

extends EntityResult

Extended EntityResult that adds information about number of records and index of first record of ResultSet contained. This object is returned in {@link TableEntity#query(java.util.Hashtable, java.util.Vector, int, int, int, java.util.Vector) to allow that Table component is pageable.

Author:

Imatia Innovation

See Also:

Table.QUERY_ROWS, PageFetcher, Serialized Form

Nested Class Summary

Nested classes inherited from class com.ontimize.db.EntityResult

EntityResult.TimeUtil, EntityResult.Uncompressor

Field Summary

protected int	startRecordIndex
protected int	totalQueryRecordsNumber

Fields inherited from class com.ontimize.db.EntityResult

BEST_COMPRESSION, BEST_SPEED, code, columnsOrder, columnsSQLTypes, compressionLevel, compressionThreshold, data, DATA_RESULT, dataByteNumber, DEBUG, DEFAULT_COMPRESSION, DEFAULT_COMPRESSION_THRESHOLD, detail, HUFFMAN_ONLY, message, messageParameter, MIN_BYTE_PROGRESS, NO_COMPRESSION, NODATA_RESULT, OPERATION_SUCCESSFUL, OPERATION_SUCCESSFUL_SHOW_MESSAGE, OPERATION_WRONG, operationId, streamTime, type

Constructor Summary

AdvancedEntityResult(int cod, int type)
Creates an AdvancedEntityResult with code 'cod' and type 'type'

AdvancedEntityResult(int cod, int type, int totalQueryRecords)
Creates an AdvancedEntityResult with code 'cod', type 'type', and the total query records number equals to 'totalQueryRecords'

AdvancedEntityResult(int cod, int type, java.lang.String m)
Creates an AdvancedEntityResult with code value 'cod', with type 'type' and the message 'm'

AdvancedEntityResult(int cod, int type, java.lang.String m, int totalQueryRecords)
Creates an AdvancedEntityResult with code 'cod', type 'type' and with the message 'm', and the total query records number equals to 'totalQueryRecords'

Method Summary

int	getCurrentRecordCount() Gets the total records number that the object contains.
int	getStartRecordIndex()
int	getTotalRecordCount() Gets the total query records count
void	setStartRecordIndex(int startRecordIndex)
void	setTotalRecordCount(int totalQueryRecords) Sets the total query records count

Methods inherited from class com.ontimize.db.EntityResult

addRecord, addRecord, calculateRecordNumber, clear, clone, compressionBytes, contains, containsKey, containsValue, deepClone, deleteRecord, elements, entrySet, get, get, getBytesNumber, getCode, getColumnSQLType, getColumnSQLTypes, getCompressionThreshold, getDetails, getMessage, getMessageParameter, getOrderColumns, getRecordIndex, getRecordValues, getRecordValues, getStreamTime, getType, indexOfData, isEmpty, isWrong, keys, keySet, put, putAll, remove, setCode, setColumnOrder, setColumnSQLTypes, setCompressionLevel, setCompressionThreshold, setMessage, setMessage, setMessageParameters, setOperationId, setType, size, toString, uncompressionBytes, uncompressionBytes, values

Methods inherited from class java.util.Hashtable

equals, hashCode, rehash

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

totalQueryRecordsNumber

protected int totalQueryRecordsNumber

startRecordIndex

protected int startRecordIndex

Constructor Detail

AdvancedEntityResult

public AdvancedEntityResult(int cod,
                            int type,
                            java.lang.String m)

Creates an AdvancedEntityResult with code value 'cod', with type 'type' and the message 'm'

Parameters:

cod -

type -

m -

AdvancedEntityResult

public AdvancedEntityResult(int cod,
                            int type)

Creates an AdvancedEntityResult with code 'cod' and type 'type'

Parameters:

cod -

type -

AdvancedEntityResult

public AdvancedEntityResult(int cod,
                            int type,
                            java.lang.String m,
                            int totalQueryRecords)

Creates an AdvancedEntityResult with code 'cod', type 'type' and with the message 'm', and the total query records number equals to 'totalQueryRecords'

Parameters:

cod -

type -

m -

totalQueryRecords -

AdvancedEntityResult

public AdvancedEntityResult(int cod,
                            int type,
                            int totalQueryRecords)

Creates an AdvancedEntityResult with code 'cod', type 'type', and the total query records number equals to 'totalQueryRecords'

Parameters:

cod -

type -

totalQueryRecords -

Method Detail

getStartRecordIndex

public int getStartRecordIndex()

setStartRecordIndex

public void setStartRecordIndex(int startRecordIndex)

getTotalRecordCount

public int getTotalRecordCount()

Gets the total query records count

Returns:

setTotalRecordCount

public void setTotalRecordCount(int totalQueryRecords)

Sets the total query records count

Parameters:

totalQueryRecords -

getCurrentRecordCount

public int getCurrentRecordCount()

Gets the total records number that the object contains.

Returns:

The object records number. When the object is empty return 0