EntityResult (ontimize-core 5.6.0 API)

java.lang.Object
- java.util.Dictionary<K,V>
- - java.util.Hashtable
  - - com.ontimize.db.EntityResult

All Implemented Interfaces:

Serializable, Cloneable, Map

Direct Known Subclasses:

AdvancedEntityResult
```
public class EntityResult
extends Hashtable
```
See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class EntityResult.TimeUtil

protected class EntityResult.Uncompressor

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`EntityResult.TimeUtil`
`protected class`	`EntityResult.Uncompressor`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BEST_COMPRESSION`
`static int`	`BEST_SPEED`
`protected int`	`code`
`protected List`	`columnsOrder`
`protected Hashtable`	`columnsSQLTypes`
`protected int`	`compressionLevel`
`protected int`	`compressionThreshold` Compression Threshold.
`protected Hashtable`	`data` Object needed for the compression mechanism
`static int`	`DATA_RESULT`
`protected int`	`dataByteNumber`
`static boolean`	`DEBUG`
`static int`	`DEFAULT_COMPRESSION`
`static int`	`DEFAULT_COMPRESSION_THRESHOLD`
`protected String`	`detail`
`static int`	`HUFFMAN_ONLY`
`protected String`	`message`
`protected Object[]`	`messageParameter`
`protected int`	`MIN_BYTE_PROGRESS`
`protected static int`	`MIN_PERCENT_PROGRESS`
`static int`	`NO_COMPRESSION`
`static int`	`NODATA_RESULT`
`static int`	`OPERATION_SUCCESSFUL`
`static int`	`OPERATION_SUCCESSFUL_SHOW_MESSAGE`
`static int`	`OPERATION_WRONG`
`protected String`	`operationId`
`protected long`	`streamTime`
`protected int`	`type`

Constructor Summary

Constructors
Constructor and Description
`EntityResult()` Creates a EntityResult with code = OPERATION_SUCCESSFUL and type = NODATA_RESULT
`EntityResult(Hashtable h)`
`EntityResult(int operationCode, int resultType)`
`EntityResult(int operationCode, int resultType, String resultMessage)`
`EntityResult(List columns)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addRecord(Hashtable data)`
`void`	`addRecord(Hashtable data, int s)`
`int`	`calculateRecordNumber()`
`void`	`clear()`
`Object`	`clone()`
`protected byte[]`	`compressionBytes(byte[] bytesToCompress, int compressionLevel)`
`boolean`	`contains(Object value)`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`EntityResult`	`deepClone()`
`void`	`deleteRecord(int index)`
`Enumeration`	`elements()`
`Set`	`entrySet()`
`Object`	`get(Object key)`
`Object`	`get(Object cod, Object attr)`
`int`	`getBytesNumber()`
`int`	`getCode()`
`int`	`getColumnSQLType(String col)`
`Hashtable`	`getColumnSQLTypes()`
`int`	`getCompressionThreshold()`
`String`	`getDetails()`
`String`	`getMessage()`
`Object[]`	`getMessageParameter()`
`List`	`getOrderColumns()`
`int`	`getRecordIndex(Hashtable kv)`
`Hashtable`	`getRecordValues(int i)`
`Hashtable`	`getRecordValues(int i, Vector vKeys)`
`long`	`getStreamTime()`
`int`	`getType()`
`int`	`indexOfData(Hashtable dataKeys)`
`boolean`	`isEmpty()`
`boolean`	`isWrong()` Returns true when code is equals to 1.
`Enumeration`	`keys()`
`Set`	`keySet()`
`static void`	`main(String[] args)`
`Object`	`put(Object key, Object value)`
`void`	`putAll(Map m)`
`Object`	`remove(Object key)`
`void`	`setCode(int operationCode)`
`void`	`setColumnOrder(List l)`
`void`	`setColumnSQLTypes(Hashtable types)`
`void`	`setCompressionLevel(int level)`
`void`	`setCompressionThreshold(int threshold)`
`void`	`setMessage(String operationMessage)`
`void`	`setMessage(String operationMessage, String operationDetails)`
`void`	`setMessageParameters(Object[] params)`
`void`	`setOperationId(String opId)`
`void`	`setType(int operationType)`
`int`	`size()`
`String`	`toString()`
`protected byte[]`	`uncompressionBytes(byte[] bytesADescomprimir)`
`protected byte[]`	`uncompressionBytes(InputStream in, int byteNumber)`
`Collection`	`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

DEBUG
```
public static boolean DEBUG
```

OPERATION_SUCCESSFUL
```
public static final int OPERATION_SUCCESSFUL
```
See Also:
Constant Field Values

OPERATION_SUCCESSFUL_SHOW_MESSAGE
```
public static final int OPERATION_SUCCESSFUL_SHOW_MESSAGE
```
See Also:
Constant Field Values

OPERATION_WRONG
```
public static final int OPERATION_WRONG
```
See Also:
Constant Field Values

DATA_RESULT
```
public static final int DATA_RESULT
```
See Also:
Constant Field Values

NODATA_RESULT
```
public static final int NODATA_RESULT
```
See Also:
Constant Field Values

DEFAULT_COMPRESSION_THRESHOLD
```
public static final int DEFAULT_COMPRESSION_THRESHOLD
```
See Also:
Constant Field Values

NO_COMPRESSION
```
public static final int NO_COMPRESSION
```
See Also:
Constant Field Values

BEST_COMPRESSION
```
public static final int BEST_COMPRESSION
```
See Also:
Constant Field Values

BEST_SPEED
```
public static final int BEST_SPEED
```
See Also:
Constant Field Values

DEFAULT_COMPRESSION
```
public static final int DEFAULT_COMPRESSION
```
See Also:
Constant Field Values

HUFFMAN_ONLY
```
public static final int HUFFMAN_ONLY
```
See Also:
Constant Field Values

MIN_BYTE_PROGRESS
```
protected int MIN_BYTE_PROGRESS
```

MIN_PERCENT_PROGRESS

protected static int MIN_PERCENT_PROGRESS

compressionThreshold
```
protected int compressionThreshold
```
Compression Threshold.

type
```
protected int type
```

code
```
protected int code
```

message
```
protected String message
```

messageParameter
```
protected Object[] messageParameter
```

detail
```
protected String detail
```

operationId
```
protected String operationId
```

columnsOrder
```
protected List columnsOrder
```

data
```
protected transient Hashtable data
```
Object needed for the compression mechanism

compressionLevel

protected transient int compressionLevel

dataByteNumber
```
protected transient int dataByteNumber
```

streamTime
```
protected transient long streamTime
```

columnsSQLTypes
```
protected Hashtable columnsSQLTypes
```

Constructor Detail

EntityResult
```
public EntityResult()
```
Creates a EntityResult with code = OPERATION_SUCCESSFUL and type = NODATA_RESULT

EntityResult
```
public EntityResult(List columns)
```

EntityResult
```
public EntityResult(Hashtable h)
```

EntityResult

public EntityResult(int operationCode,
            int resultType)

EntityResult

public EntityResult(int operationCode,
            int resultType,
            String resultMessage)

Method Detail

getType
```
public int getType()
```

getCode
```
public int getCode()
```

getMessage
```
public String getMessage()
```

getDetails
```
public String getDetails()
```

setType

public void setType(int operationType)

setCode

public void setCode(int operationCode)

setMessage

public void setMessage(String operationMessage)

setMessageParameters

public void setMessageParameters(Object[] params)

getMessageParameter
```
public Object[] getMessageParameter()
```

setMessage

public void setMessage(String operationMessage,
              String operationDetails)

clear
```
public void clear()
```
Specified by:

clear in interface Map

Overrides:

clear in class Hashtable

contains
```
public boolean contains(Object value)
```
Overrides:

contains in class Hashtable

containsKey
```
public boolean containsKey(Object key)
```
Specified by:

containsKey in interface Map

Overrides:

containsKey in class Hashtable

containsValue
```
public boolean containsValue(Object value)
```
Specified by:

containsValue in interface Map

Overrides:

containsValue in class Hashtable

elements
```
public Enumeration elements()
```
Overrides:

elements in class Hashtable

clone
```
public Object clone()
```
Overrides:

clone in class Hashtable

deepClone
```
public EntityResult deepClone()
```

entrySet
```
public Set entrySet()
```
Specified by:

entrySet in interface Map

Overrides:

entrySet in class Hashtable

get
```
public Object get(Object key)
```
Specified by:

get in interface Map

Overrides:

get in class Hashtable

get

public Object get(Object cod,
         Object attr)

isEmpty
```
public boolean isEmpty()
```
Specified by:

isEmpty in interface Map

Overrides:

isEmpty in class Hashtable

keys
```
public Enumeration keys()
```
Overrides:

keys in class Hashtable

keySet
```
public Set keySet()
```
Specified by:

keySet in interface Map

Overrides:

keySet in class Hashtable

put

public Object put(Object key,
         Object value)

Specified by:: put in interface Map
Overrides:: put in class Hashtable

putAll
```
public void putAll(Map m)
```
Specified by:

putAll in interface Map

Overrides:

putAll in class Hashtable

remove
```
public Object remove(Object key)
```
Specified by:

remove in interface Map

Overrides:

remove in class Hashtable

size
```
public int size()
```
Specified by:

size in interface Map

Overrides:

size in class Hashtable

toString
```
public String toString()
```
Overrides:

toString in class Hashtable

values
```
public Collection values()
```
Specified by:

values in interface Map

Overrides:

values in class Hashtable

setCompressionLevel

public void setCompressionLevel(int level)

setCompressionThreshold

public void setCompressionThreshold(int threshold)

getCompressionThreshold
```
public int getCompressionThreshold()
```

compressionBytes

protected byte[] compressionBytes(byte[] bytesToCompress,
                      int compressionLevel)

uncompressionBytes

protected byte[] uncompressionBytes(byte[] bytesADescomprimir)

uncompressionBytes

protected byte[] uncompressionBytes(InputStream in,
                        int byteNumber)

calculateRecordNumber
```
public int calculateRecordNumber()
```

getRecordValues

public Hashtable getRecordValues(int i)

getRecordValues

public Hashtable getRecordValues(int i,
                        Vector vKeys)

getStreamTime
```
public long getStreamTime()
```

getBytesNumber
```
public int getBytesNumber()
```

addRecord

public void addRecord(Hashtable data)

addRecord

public void addRecord(Hashtable data,
             int s)

deleteRecord
```
public void deleteRecord(int index)
```

isWrong
```
public boolean isWrong()
```
Returns true when code is equals to 1.

Returns:
condition about successful/wrong state
Since:

5.2068EN-0.1

indexOfData

public int indexOfData(Hashtable dataKeys)

getRecordIndex

public int getRecordIndex(Hashtable kv)

getColumnSQLTypes
```
public Hashtable getColumnSQLTypes()
```

setColumnSQLTypes

public void setColumnSQLTypes(Hashtable types)

getColumnSQLType

public int getColumnSQLType(String col)

setOperationId

public void setOperationId(String opId)

getOrderColumns
```
public List getOrderColumns()
```

setColumnOrder
```
public void setColumnOrder(List l)
```

main

public static void main(String[] args)

Class EntityResult

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.Hashtable

Methods inherited from class java.lang.Object

Field Detail

DEBUG

OPERATION_SUCCESSFUL

OPERATION_SUCCESSFUL_SHOW_MESSAGE

OPERATION_WRONG

DATA_RESULT

NODATA_RESULT

DEFAULT_COMPRESSION_THRESHOLD

NO_COMPRESSION

BEST_COMPRESSION

BEST_SPEED

DEFAULT_COMPRESSION

HUFFMAN_ONLY

MIN_BYTE_PROGRESS

MIN_PERCENT_PROGRESS

compressionThreshold

type

code

message

messageParameter

detail

operationId

columnsOrder

data

compressionLevel

dataByteNumber

streamTime

columnsSQLTypes

Constructor Detail

EntityResult

EntityResult

EntityResult

EntityResult

EntityResult

Method Detail

getType

getCode

getMessage

getDetails

setType

setCode

setMessage

setMessageParameters

getMessageParameter

setMessage

clear

contains

containsKey

containsValue

elements

clone

deepClone

entrySet

get

get

isEmpty

keys

keySet

put

putAll

remove

size

toString

values

setCompressionLevel

setCompressionThreshold

getCompressionThreshold

compressionBytes

uncompressionBytes

uncompressionBytes

calculateRecordNumber

getRecordValues

getRecordValues