org.eclipse.keyple.calypso.transaction

Class FileData

java.lang.Object

org.eclipse.keyple.calypso.transaction.FileData

All Implemented Interfaces:

java.io.Serializable

public class FileData
extends java.lang.Object
implements java.io.Serializable

This POJO contains all known data content of a Calypso EF.

Since:

0.9

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
java.util.SortedMap<java.lang.Integer,java.lang.Integer>	getAllCountersValue() Gets all known counters value. The counters values are extracted from record #1. If last counter has a truncated value (when size of record #1 modulo 3 != 0), then last counter value is not returned.
java.util.SortedMap<java.lang.Integer,byte[]>	getAllRecordsContent() Gets a reference to all known records content.
byte[]	getContent() Gets a reference to the known content of record #1. For a Binary file, it means all the bytes of the file.
byte[]	getContent(int numRecord) Gets a reference to the known content of a specific record.
byte[]	getContent(int numRecord, int dataOffset, int dataLength) Gets a copy of a known content subset of a specific record from dataOffset to dataLength.
int	getContentAsCounterValue(int numCounter) Gets the known value of the counter #numCounter. The counter value is extracted from the 3 next bytes at the index [(numCounter - 1) * 3] of the record #1. e.g.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getAllRecordsContent

public java.util.SortedMap<java.lang.Integer,byte[]> getAllRecordsContent()

Gets a reference to all known records content.

Returns:

a not null map eventually empty if there's no content.

Since:

0.9

getContent

public byte[] getContent()

Gets a reference to the known content of record #1.
For a Binary file, it means all the bytes of the file.

Returns:

a not empty reference to the record content.

Throws:

java.util.NoSuchElementException - if record #1 is not set.

Since:

0.9

getContent

public byte[] getContent(int numRecord)

Gets a reference to the known content of a specific record.

Parameters:

numRecord - the record number

Returns:

a not empty reference to the record content.

Throws:

java.util.NoSuchElementException - if record #numRecord is not set.

Since:

0.9

getContent

public byte[] getContent(int numRecord,
                         int dataOffset,
                         int dataLength)

Gets a copy of a known content subset of a specific record from dataOffset to dataLength.

Parameters:

numRecord - the record number

dataOffset - the offset index (should be >= 0)

dataLength - the data length (should be >= 1)

Returns:

a copy not empty of the record subset content.

Throws:

java.lang.IllegalArgumentException - if dataOffset < 0 or dataLength < 1.

java.util.NoSuchElementException - if record #numRecord is not set.

java.lang.IndexOutOfBoundsException - if dataOffset >= content length or (dataOffset + dataLength) > content length.

Since:

0.9

getContentAsCounterValue

public int getContentAsCounterValue(int numCounter)

Gets the known value of the counter #numCounter.
The counter value is extracted from the 3 next bytes at the index [(numCounter - 1) * 3] of the record #1.
e.g. if numCounter == 2, then value is extracted from bytes indexes [3,4,5].

Parameters:

numCounter - the counter number (should be >= 1)

Returns:

the counter value.

Throws:

java.lang.IllegalArgumentException - if numCounter is < 1.

java.util.NoSuchElementException - if record #1 or numCounter is not set.

java.lang.IndexOutOfBoundsException - if numCounter has a truncated value (when size of record #1 modulo 3 != 0).

Since:

0.9

getAllCountersValue

public java.util.SortedMap<java.lang.Integer,java.lang.Integer> getAllCountersValue()

Gets all known counters value.
The counters values are extracted from record #1.
If last counter has a truncated value (when size of record #1 modulo 3 != 0), then last counter value is not returned.

Returns:

a not empty object.

Throws:

java.util.NoSuchElementException - if record #1 is not set.

Since:

0.9

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object