com.googlecode.whatswrong
Class Token

java.lang.Object
  com.googlecode.whatswrong.Token

All Implemented Interfaces:

Comparable<Token>

public class Token
extends Object
implements Comparable<Token>

A Token represents a word in an utterance. It consists of an index and a set of properties with name and value.

Author:

Sebastian Riedel

Constructor Summary

Token(int index)
Creates a new token with the given index.

Method Summary

void	addProperty(int index, String property) Add the property with name "Property [index]" and the given value.
void	addProperty(String value) Adds a property with the given value.
Token	addProperty(String name, String value) Add a property with the given name and value.
Token	addProperty(TokenProperty property, String value) Add a property with given value.
int	compareTo(Token o) Compares the indices of both tokens.
boolean	equals(Object o) Checks whether the two tokens have the same index.
int	getIndex() Returns the index of the token.
String	getProperty(TokenProperty property) Get the value of the given property.
Collection<TokenProperty>	getPropertyTypes() Return all token properties (the property names).
Collection<String>	getPropertyValues() Returns a collection of all property values.
List<TokenProperty>	getSortedProperties() Sorts the properties by property level and name.
int	hashCode() Returns the index of the token.
void	merge(Token token) Inserts all properties and values of the other token into this token.
boolean	propertiesContain(Collection<String> substrings, boolean wholeWord) Check whether any of the property values of this token contains any of the strings in the given set of strings.
boolean	propertiesContain(String substring) Check whether any of the property values contains the given string.
void	removeProperty(int index) Remove the property value with given index.
void	removeProperty(String name) Remove the property value with the given name.
String	toString() Returns a string representation of this token containing token index and properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

Token

public Token(int index)

Creates a new token with the given index.

Parameters:

index - the index of the token.

Method Detail

getIndex

public int getIndex()

Returns the index of the token.

Returns:

the index of the token.

getPropertyTypes

public Collection<TokenProperty> getPropertyTypes()

Return all token properties (the property names). To get the value of a property use getProperty(TokenProperty).

Returns:

a collection with token properties.

getProperty

public String getProperty(TokenProperty property)

Get the value of the given property.

Parameters:

property - the property to get the value for.

Returns:

the value of the given property.

removeProperty

public void removeProperty(int index)

Remove the property value with given index.

Parameters:

index - the index of the property to remove.

removeProperty

public void removeProperty(String name)

Remove the property value with the given name.

Parameters:

name - the name of the property to remove.

addProperty

public Token addProperty(String name,
                         String value)

Add a property with the given name and value.

Parameters:

name - the name of the property.

value - the value of the property.

Returns:

a pointer to this token.

addProperty

public void addProperty(int index,
                        String property)

Add the property with name "Property [index]" and the given value.

Parameters:

index - the index of the property

property - the value of the property.

addProperty

public Token addProperty(TokenProperty property,
                         String value)

Add a property with given value.

Parameters:

property - the property to add

value - the value of the property

Returns:

this token.

addProperty

public void addProperty(String value)

Adds a property with the given value. The property name will be "Property i" where i this the current number of properties.

Parameters:

value - the value of the property.

getSortedProperties

public List<TokenProperty> getSortedProperties()

Sorts the properties by property level and name.

Returns:

a list of sorted token properties.

getPropertyValues

public Collection<String> getPropertyValues()

Returns a collection of all property values.

Returns:

a collection of all property values.

propertiesContain

public boolean propertiesContain(String substring)

Check whether any of the property values contains the given string.

Parameters:

substring - the string to check whether it is contained in any property value of this token.

Returns:

true iff there exists on property of this token for which substring is a substring of the corresponding property value.

propertiesContain

public boolean propertiesContain(Collection<String> substrings,
                                 boolean wholeWord)

Check whether any of the property values of this token contains any of the strings in the given set of strings.

Parameters:

substrings - set of strings to check

wholeWord - should we check for complete words of is it enough for the given strings to be substrings of the token value.

Returns:

true iff a) if there is a property value equal to one of the strings in substrings (wholeword=true) or b) if there is a property value that contains one of the strings in substrings (wholeword=false).

equals

public boolean equals(Object o)

Checks whether the two tokens have the same index. (Hence equality is only defined through the position of the token in the sentence.

Overrides:

equals in class Object

Parameters:

o - the other token.

Returns:

index==((Token)o).index

hashCode

public int hashCode()

Returns the index of the token.

Overrides:

hashCode in class Object

Returns:

the index of the token.

merge

public void merge(Token token)

Inserts all properties and values of the other token into this token. In case of clashes the value of the other token is taken.

Parameters:

token - the token to merge with.

compareTo

public int compareTo(Token o)

Compares the indices of both tokens.

Specified by:

compareTo in interface Comparable<Token>

Parameters:

o - the other token.

Returns:

index - o.getIndex()

toString

public String toString()

Returns a string representation of this token containing token index and properties.

Overrides:

toString in class Object

Returns:

a string representation of this token.