org.ai_heuristic.model

Class MetaBagOfWords

java.lang.Object

org.ai_heuristic.model.BagOfWords

org.ai_heuristic.model.MetaBagOfWords

public class MetaBagOfWords
extends BagOfWords

This is a bag of words structure that also stores other metadata.

Author:

Kieran Greer

Field Summary

Fields inherited from class org.ai_heuristic.model.BagOfWords

bagOfWords, name, wordOrder

Constructor Summary

Constructors

Constructor and Description
MetaBagOfWords() Create a new instance of MetaBagOfWords

Method Summary

Modifier and Type	Method and Description
protected void	copyOther(MetaBagOfWords copyFrom) Copy the other fields in the parameter passed in to this bag of words.
BagOfWords	difference(BagOfWords thisBagOfWords) Create a new bag of words that is the difference between of this one and the one passed in.
float	dotproduct(BagOfWords thisBagOfWords) Calculate the dotproduct value of this bag-of-words with the one passed in.
float	dotproductOther(BagOfWords thisBagOfWords) Update this bag of words with dotproduct of the 'other' fields from the parameter passed in.
java.lang.String	getDirection() Get the movement direction.
static java.lang.String	getDirectionUnion(java.lang.String direction1, java.lang.String direction2) Get the combination of the two directions.
int	getItemCount() Get a count of all items in the bag.
int	getTotalItemCount() Get a count of all items in the bag.
java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>>	getTypeSet() Get the words type sets.
BagOfWords	intersection(BagOfWords thisBagOfWords) Create a new bag of words that is the intersection of this one with the one passed in.
protected void	intersectionOther(MetaBagOfWords intersectWith) Update this bag of words with intersections of the 'other' fields from the parameter passed in.
float	magnitude(BagOfWords thisBagOfWords) Calculate the magnitude value of this bag-of-words with the one passed in.
float	magnitudeOther(BagOfWords thisBagOfWords) Update this bag of words with magnitude of the 'other' fields from the parameter passed in.
boolean	otherIsSame(MetaBagOfWords compareWith) Compare the other metadata with this bag-of-words metadata and return true if they are the same.
void	setDirection(java.lang.String thisDirection) Set the movement direction.
boolean	setTypeSet(java.lang.String theWord, java.util.ArrayList<java.lang.String> wordTypes) Set the type set for the specified word.
BagOfWords	subtract(BagOfWords thisBagOfWords) Create a new bag of words that is the subtraction of the bag passed in from this one.
org.licas_xml.abs.Element	toXml() Convert this bag of words into an XML format.
BagOfWords	union(BagOfWords thisBagOfWords) Create a new bag of words that is the union of this one with the one passed in.
protected void	unionOther(MetaBagOfWords unionWith) Update this bag of words with unions of the 'other' fields from the parameter passed in.

Methods inherited from class org.ai_heuristic.model.BagOfWords

createBagOfWords, createBagOfWords, getBagOfWords, getName, getTotalWordCount, getWordOrder, orderBagOfWords, removeWords, sameWordList, setBagOfWords, setBagOfWords, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaBagOfWords

public MetaBagOfWords()

Create a new instance of MetaBagOfWords

Method Detail

setTypeSet

public boolean setTypeSet(java.lang.String theWord,
                          java.util.ArrayList<java.lang.String> wordTypes)

Set the type set for the specified word.

Parameters:

theWord - the parsed word name.

wordTypes - a list of word types, of type TextConst.NOUN, VERB, ADJECTIVE, ADVERB.

Returns:

true if added, false if the word is not currently in the bag-of-words list.

subtract

public BagOfWords subtract(BagOfWords thisBagOfWords)
                    throws java.lang.Exception

Create a new bag of words that is the subtraction of the bag passed in from this one. The counts for items in the bag passed in are subtracted from the counts of similar items in this bag. If the result is less than 0 then it is set to 0. Any other items in only this bag are also kept.

Overrides:

subtract in class BagOfWords

Parameters:

thisBagOfWords - the bag of words to intersect with.

Returns:

a new BagOfWords structure with the appropriate word counts.

Throws:

java.lang.Exception - any error.

difference

public BagOfWords difference(BagOfWords thisBagOfWords)
                      throws java.lang.Exception

Create a new bag of words that is the difference between of this one and the one passed in. This should be the reciprocal of the intersection. The counts for items in the bag passed in are subtracted from the counts of similar items in this bag and the absolute value taken. Any other items in either bag are also kept.

Overrides:

difference in class BagOfWords

Parameters:

thisBagOfWords - the bag of words to intersect with.

Returns:

a new BagOfWords structure with the appropriate word counts.

Throws:

java.lang.Exception - any error.

intersection

public BagOfWords intersection(BagOfWords thisBagOfWords)
                        throws java.lang.Exception

Create a new bag of words that is the intersection of this one with the one passed in. The counts for the same item are averaged.

Overrides:

intersection in class BagOfWords

Parameters:

thisBagOfWords - the bag of words to intersect with.

Returns:

a new BagOfWords structure with the appropriate word counts.

Throws:

java.lang.Exception - any error.

union

public BagOfWords union(BagOfWords thisBagOfWords)
                 throws java.lang.Exception

Create a new bag of words that is the union of this one with the one passed in. The counts for the same item in both bags are averaged.

Overrides:

union in class BagOfWords

Parameters:

thisBagOfWords - the bag of words to intersect with.

Returns:

a new BagOfWords structure with the appropriate word counts.

Throws:

java.lang.Exception - any error.

dotproduct

public float dotproduct(BagOfWords thisBagOfWords)

Calculate the dotproduct value of this bag-of-words with the one passed in. The counts for the same item in both bags are multiplied and summed.

Overrides:

dotproduct in class BagOfWords

Parameters:

thisBagOfWords - the bag of words to combine with.

Returns:

the total dotproduct count.

dotproductOther

public float dotproductOther(BagOfWords thisBagOfWords)

Update this bag of words with dotproduct of the 'other' fields from the parameter passed in. Fields not the same are set to null.

Parameters:

thisBagOfWords - the bag of words to combine with.

Returns:

the total dotproduct count.

magnitude

public float magnitude(BagOfWords thisBagOfWords)

Calculate the magnitude value of this bag-of-words with the one passed in. The counts for each item in a bag is squared and summed. Both counts are then multiplied together.

Overrides:

magnitude in class BagOfWords

Parameters:

thisBagOfWords - the bag of words to combine with.

Returns:

the total magnitude count.

magnitudeOther

public float magnitudeOther(BagOfWords thisBagOfWords)

Update this bag of words with magnitude of the 'other' fields from the parameter passed in. Fields not the same are set to null.

Parameters:

thisBagOfWords - the bag of words to combine with.

Returns:

the total magnitude count.

copyOther

protected void copyOther(MetaBagOfWords copyFrom)

Copy the other fields in the parameter passed in to this bag of words.

Parameters:

copyFrom - the bag of words to copy from.

otherIsSame

public boolean otherIsSame(MetaBagOfWords compareWith)

Compare the other metadata with this bag-of-words metadata and return true if they are the same.

Parameters:

compareWith - the meta bag-of-words to compare with.

Returns:

true if the other meta is the same.

intersectionOther

protected void intersectionOther(MetaBagOfWords intersectWith)

Update this bag of words with intersections of the 'other' fields from the parameter passed in. Fields not the same are set to null.

Parameters:

intersectWith - the second bag of words to intersect with.

unionOther

protected void unionOther(MetaBagOfWords unionWith)

Update this bag of words with unions of the 'other' fields from the parameter passed in. Fields are combined in some way to produce a new value.

Parameters:

unionWith - the second bag of words to combine with.

getItemCount

public int getItemCount()

Get a count of all items in the bag. This is a word count and also a count of any other metadata items.

Returns:

a count of all items in the bag.

getTotalItemCount

public int getTotalItemCount()

Get a count of all items in the bag. This is a word count and also a count of any other metadata items.

Returns:

a count of all items in the bag.

getTypeSet

public java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> getTypeSet()

Get the words type sets.

Returns:

the value of typeSet.

setDirection

public void setDirection(java.lang.String thisDirection)

Set the movement direction.

Parameters:

thisDirection - the direction - N, S, NE, etc.

getDirection

public java.lang.String getDirection()

Get the movement direction.

Returns:

the value of direction.

toXml

public org.licas_xml.abs.Element toXml()
                                throws java.lang.Exception

Convert this bag of words into an XML format.

Overrides:

toXml in class BagOfWords

Returns:

the xml-based representation of this bag of words.

Throws:

java.lang.Exception - any error.

getDirectionUnion

public static java.lang.String getDirectionUnion(java.lang.String direction1,
                                                 java.lang.String direction2)

Get the combination of the two directions.

Parameters:

direction1 - the first direction.

direction2 - the second direction.

Returns:

an intersection of these two directions.