textbender.a.u.transfer
Class Transferand

java.lang.Object
  Transferand

All Implemented Interfaces:

Serializable

@ThreadSafe
public final class Transferand
extends Object
implements Serializable

An object of a paired-region transfer. It defines a contiguous region of the source document.

See Also:

Serialized Form

Constructor Summary

Transferand(HostServiceRegistry.UniqueID origin, File documentFile, int gIndex0, int gIndex1)
Creates a Transferand.

Method Summary

File	documentFile() A file containing a copy of the source document.
boolean	equals(Object o) Returns true iff o is a transferand from the same document file, and with the same g-indeces.
int	gIndex0() Returns the g-index of the first gene of the transferand, in document order.
int	gIndex1() Returns the g-index of the last gene of the transferand, in document order.
HostServiceRegistry.UniqueID	origin() Identifies the program agent that constructed the transferand.

Methods inherited from class java.lang.Object

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

Constructor Detail

Transferand

public Transferand(HostServiceRegistry.UniqueID origin,
                   File documentFile,
                   int gIndex0,
                   int gIndex1)

Creates a Transferand.

Parameters:

origin - per origin()

documentFile - per documentFile()

gIndex0 - per gIndex0()

gIndex1 - per gIndex1()

Method Detail

documentFile

public File documentFile()

A file containing a copy of the source document.

gIndex0

public int gIndex0()

Returns the g-index of the first gene of the transferand, in document order.

gIndex1

public int gIndex1()

Returns the g-index of the last gene of the transferand, in document order.

origin

public final HostServiceRegistry.UniqueID origin()

Identifies the program agent that constructed the transferand.

equals

public boolean equals(Object o)

Returns true iff o is a transferand from the same document file, and with the same g-indeces. The origin may differ, however.

Overrides:

equals in class Object