ivory.ptc.data

Class AnchorTextTarget

java.lang.Object

ivory.ptc.data.AnchorTextTarget

All Implemented Interfaces:

Comparable<AnchorTextTarget>, Iterable<Integer>, Writable, WritableComparable<AnchorTextTarget>

public class AnchorTextTarget
extends Object
implements WritableComparable<AnchorTextTarget>, Iterable<Integer>

Data structure that holds a target document along with a list of (source) documents that point to the target document. In addition, a weight field is associated with the target document if necessary. The iterator method iterates over the source documents that point to the target document.

Author:

Nima Asadi

Constructor Summary

Constructors

Constructor and Description
AnchorTextTarget() Constructs a target with an empty source list.
AnchorTextTarget(AnchorTextTarget at) Constructs a target by cloning an existing target.
AnchorTextTarget(int trgt, ArrayListOfIntsWritable srcs, float wt) Constructs a target object from scratch.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSources(ArrayListOfIntsWritable sources) Adds source documents to the list of source documents that point to the current target document.
int	compareTo(AnchorTextTarget at)
boolean	equals(Object o)
ArrayListOfIntsWritable	getSources() Retrieves the list of source documents.
int	getTarget() Retrieves the target document id.
float	getWeight()
int	hashCode()
Iterator<Integer>	iterator()
void	readFields(DataInput in)
void	setSources(ArrayListOfIntsWritable sources) Resets the source list to the given list.
void	setTarget(int target) Sets the target document.
void	setWeight(float wt) Sets the weight for the current target document.
String	toString()
void	write(DataOutput out)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AnchorTextTarget

public AnchorTextTarget()

Constructs a target with an empty source list.

AnchorTextTarget

public AnchorTextTarget(AnchorTextTarget at)

Constructs a target by cloning an existing target.

Parameters:

at - Existing target object.

AnchorTextTarget

public AnchorTextTarget(int trgt,
                ArrayListOfIntsWritable srcs,
                float wt)

Constructs a target object from scratch.

Parameters:

trgt - Document id of the target document.

srcs - Source documents that point to the target document.

wt - Weight for the target document.

Method Detail

addSources

public void addSources(ArrayListOfIntsWritable sources)

Adds source documents to the list of source documents that point to the current target document.

Parameters:

sources - Source documents to be added.

compareTo

public int compareTo(AnchorTextTarget at)

Specified by:

compareTo in interface Comparable<AnchorTextTarget>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getSources

public ArrayListOfIntsWritable getSources()

Retrieves the list of source documents.

Returns:

list of source documents.

getTarget

public int getTarget()

Retrieves the target document id.

Returns:

document id of the target document.

getWeight

public float getWeight()

Returns:

weight of the target document.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

iterator

public Iterator<Integer> iterator()

Specified by:

iterator in interface Iterable<Integer>

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface Writable

Throws:

IOException

setSources

public void setSources(ArrayListOfIntsWritable sources)

Resets the source list to the given list. Please note that this method removes the existing list with the given parameter; i.e., the source list will be reset and re-initialized.

Parameters:

sources - Source documents to be initialized with.

setTarget

public void setTarget(int target)

Sets the target document.

Parameters:

target - New target document id.

setWeight

public void setWeight(float wt)

Sets the weight for the current target document.

Parameters:

wt - Weight

toString

public String toString()

Overrides:

toString in class Object

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface Writable

Throws:

IOException