edu.iu.harp.io

Class Data

java.lang.Object

edu.iu.harp.io.Data

public class Data
extends java.lang.Object

The wrapper of data used in communication. The fields in data must be consistent

Constructor Summary

Constructors

Constructor and Description
Data(ByteArray headArr)
Data(ByteArray headArr, ByteArray bodyArr)
Data(byte type, java.lang.String conName, int wID, java.util.List<Transferable> object, int s) Construct a data
Data(byte type, java.lang.String conName, int wID, java.util.List<Transferable> object, int s, java.lang.String opName) Construct an operation data
Data(byte type, java.lang.String conName, int wID, java.util.List<Transferable> object, int s, java.lang.String opName, int parID) Construct a partition data in an operation

Method Summary

Modifier and Type	Method and Description
DataStatus	decodeBodyArray() Decode the bodyArray as the body
DataStatus	decodeHeadArray() Decode the headArray as the head
DataStatus	encodeBody() Encode the body as a ByteArray
DataStatus	encodeHead() Encode the head as a ByteArray
java.util.List<Transferable>	getBody() Get the body
ByteArray	getBodyArray() Get the body array
int	getBodySize() Get the size of the body
DataStatus	getBodyStatus() Get the DataStatus of the body
byte	getBodyType() Get the type of the body
java.lang.String	getContextName() Get the name of the context
ByteArray	getHeadArray() Get the head array
DataStatus	getHeadStatus() Get the DataStatus of the head
java.lang.String	getOperationName() Get the name of the operation
int	getPartitionID() Get the ID of the partition
int	getWorkerID() Get the ID of the Worker
boolean	isData() Check if this is Data Data > Operation Data > Partition Data
boolean	isOperationData() Check if this is an operation data
boolean	isPartitionData() Check if this is a partition data
void	release() Release the Data
void	releaseBodyArray() Release the data body array.
void	releaseHeadArray() Release the head array.

Methods inherited from class java.lang.Object

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

Constructor Detail

Data

public Data(byte type,
            java.lang.String conName,
            int wID,
            java.util.List<Transferable> object,
            int s)

Construct a data

Data

public Data(byte type,
            java.lang.String conName,
            int wID,
            java.util.List<Transferable> object,
            int s,
            java.lang.String opName)

Construct an operation data

Data

public Data(byte type,
            java.lang.String conName,
            int wID,
            java.util.List<Transferable> object,
            int s,
            java.lang.String opName,
            int parID)

Construct a partition data in an operation

Data

public Data(ByteArray headArr)

Data

public Data(ByteArray headArr,
            ByteArray bodyArr)

Method Detail

isData

public boolean isData()

Check if this is Data Data > Operation Data > Partition Data

isOperationData

public boolean isOperationData()

Check if this is an operation data

Returns:

true if this is an operation data

isPartitionData

public boolean isPartitionData()

Check if this is a partition data

Returns:

true if this is a partition data

getBodyType

public byte getBodyType()

Get the type of the body

Returns:

the type of the body

getContextName

public java.lang.String getContextName()

Get the name of the context

Returns:

the name of the context

getWorkerID

public int getWorkerID()

Get the ID of the Worker

Returns:

the ID of the Worker

getOperationName

public java.lang.String getOperationName()

Get the name of the operation

Returns:

the name of the operation

getPartitionID

public int getPartitionID()

Get the ID of the partition

Returns:

the ID of the partition

getBodySize

public int getBodySize()

Get the size of the body

Returns:

the size of the body

getBody

public java.util.List<Transferable> getBody()

Get the body

Returns:

the body

getHeadArray

public ByteArray getHeadArray()

Get the head array

Returns:

the head array

getBodyArray

public ByteArray getBodyArray()

Get the body array

Returns:

the body array

getHeadStatus

public DataStatus getHeadStatus()

Get the DataStatus of the head

Returns:

the DataStatus of the head

getBodyStatus

public DataStatus getBodyStatus()

Get the DataStatus of the body

Returns:

the DataStatus of the body

releaseHeadArray

public void releaseHeadArray()

Release the head array. If the array is removed without encode/decode, make sure that the data status is correct. Other states shouldn't have encoded head array

releaseBodyArray

public void releaseBodyArray()

Release the data body array. If the array is removed without encode/decode, make sure that the data status is correct

release

public void release()

Release the Data

decodeHeadArray

public DataStatus decodeHeadArray()

Decode the headArray as the head

Returns:

decodeBodyArray

public DataStatus decodeBodyArray()

Decode the bodyArray as the body

Returns:

the DataStatus

encodeHead

public DataStatus encodeHead()

Encode the head as a ByteArray

Returns:

the DataStatus

encodeBody

public DataStatus encodeBody()

Encode the body as a ByteArray

Returns:

the DataStatus