org.openimaj.math.geometry.point

Class PayloadCoordinate<T extends Coordinate,O>

java.lang.Object

org.openimaj.math.geometry.point.PayloadCoordinate<T,O>

Type Parameters:

T - Type of underlying coordinate

O - Type of payload data

All Implemented Interfaces:

Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary, Coordinate

public class PayloadCoordinate<T extends Coordinate,O>
extends Object
implements Coordinate

A concrete implementation of a Coordinate that has an associated payload.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
PayloadCoordinate(T coord, O payload) Construct with coordinate and payload.

Method Summary

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
byte[]	binaryHeader() Header for binary input.
int	getDimensions()
Number	getOrdinate(int dimension) Get the ordinate value for a specific dimension.
O	getPayload()
static <T extends Coordinate,O> PayloadCoordinate<T,O>	payload(T coord, O payload) Create a PayloadCoordinate.
void	readASCII(Scanner in) Read internal state from in.
void	readBinary(DataInput in) Read internal state from in.
void	setOrdinate(int dimension, Number value) Set the ordinate value for a specific dimension.
void	setPayload(O payload) Set the payload.
void	writeASCII(PrintWriter out) Write the content of this as ascii to out.
void	writeBinary(DataOutput out) Write the content of this as binary to out.

Methods inherited from class java.lang.Object

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

Constructor Detail

PayloadCoordinate

public PayloadCoordinate(T coord,
                         O payload)

Construct with coordinate and payload.

Parameters:

coord - The coordinate.

payload - The payload.

Method Detail

readASCII

public void readASCII(Scanner in)
               throws IOException

Description copied from interface: ReadableASCII

Read internal state from in.

Specified by:

readASCII in interface ReadableASCII

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

asciiHeader

public String asciiHeader()

Description copied from interface: ReadableASCII

Header for ascii input. Will be automatically read by IOUtils when using readASCII().

Specified by:

asciiHeader in interface ReadableASCII

Specified by:

asciiHeader in interface WriteableASCII

Returns:

header

readBinary

public void readBinary(DataInput in)
                throws IOException

Description copied from interface: ReadableBinary

Read internal state from in.

Specified by:

readBinary in interface ReadableBinary

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

binaryHeader

public byte[] binaryHeader()

Description copied from interface: ReadableBinary

Header for binary input. Will be automatically read by IOUtils when using readBinary().

Specified by:

binaryHeader in interface ReadableBinary

Specified by:

binaryHeader in interface WriteableBinary

Returns:

header

writeASCII

public void writeASCII(PrintWriter out)
                throws IOException

Description copied from interface: WriteableASCII

Write the content of this as ascii to out.

Specified by:

writeASCII in interface WriteableASCII

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

writeBinary

public void writeBinary(DataOutput out)
                 throws IOException

Description copied from interface: WriteableBinary

Write the content of this as binary to out.

Specified by:

writeBinary in interface WriteableBinary

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

getOrdinate

public Number getOrdinate(int dimension)

Description copied from interface: Coordinate

Get the ordinate value for a specific dimension.

Specified by:

getOrdinate in interface Coordinate

Parameters:

dimension - The index of the dimension we are interested in

Returns:

The value of the ordinate of the given dimension.

getDimensions

public int getDimensions()

Specified by:

getDimensions in interface Coordinate

Returns:

The number of dimensions in the coordinate.

setPayload

public void setPayload(O payload)

Set the payload.

Parameters:

payload - The payload

getPayload

public O getPayload()

Returns:

The payload.

payload

public static <T extends Coordinate,O> PayloadCoordinate<T,O> payload(T coord,
                                                                      O payload)

Create a PayloadCoordinate.

Type Parameters:

T - The coordinate type.

O - The payload type.

Parameters:

coord - The coordinate.

payload - The payload.

Returns:

the newly created PayloadCoordinate.

setOrdinate

public void setOrdinate(int dimension,
                        Number value)

Description copied from interface: Coordinate

Set the ordinate value for a specific dimension.

Specified by:

setOrdinate in interface Coordinate

Parameters:

dimension - The index of the dimension we are interested in

value - The value of the ordinate of the given dimension.