com.bericotech.clavin.extractor

Class LocationOccurrence

java.lang.Object

com.bericotech.clavin.extractor.LocationOccurrence

public class LocationOccurrence
extends Object

Container class representing a location name found in a document. Stores the text of the location name itself, as well as its position in the text in which it was found (measured in UTF-16 code points from the start of the document).

Constructor Summary

Constructors

Constructor and Description
LocationOccurrence(String text, int position) Sole construction for LocationOccurrence class.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Tests equivalence based on name and position.
int	getPosition() Get the position in the text where the location name starts.
String	getText() Get the text of the location name.
int	hashCode() Required for hashing.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LocationOccurrence

public LocationOccurrence(String text,
                          int position)

Sole construction for LocationOccurrence class. Represents a location name found in a document.

Parameters:

text - text of the location name

position - where it was found

Method Detail

getText

public String getText()

Get the text of the location name.

Returns:

the text of the location name

getPosition

public int getPosition()

Get the position in the text where the location name starts.

Returns:

the number of UTF-16 code units from the start of the document at which the location name starts

equals

public boolean equals(Object o)

Tests equivalence based on name and position.

Overrides:

equals in class Object

Parameters:

o - Object to compare this against

hashCode

public int hashCode()

Required for hashing.

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object