org.licas_text.meta

Class MatchKeywords

java.lang.Object

org.licas_text.meta.MatchKeywords

public class MatchKeywords
extends java.lang.Object

This class can be used to compare keyword lists for similarity. This includes full or partial matches of the lists.

Author:

Kieran Greer

Constructor Summary

Constructors

Constructor and Description
MatchKeywords() Create a new instance of MatchKeywords.

Method Summary

Modifier and Type	Method and Description
float	compareKeywordCounts(java.util.ArrayList<java.lang.String[]> compareWith, java.util.ArrayList<java.lang.String[]> keywords) Compare the word counts in the model passed in with this one.
protected float	compareKeywords(java.util.ArrayList<java.lang.String> compareWith, java.util.ArrayList<java.lang.String> keywords) Compare the keyword lists and check for similarity.
float	compareMetadata(java.util.ArrayList<java.lang.String> compareWith, java.util.ArrayList<java.lang.String> keywords, java.lang.String matchType) Compare the metadata as keyword lists and return the result.
float	listsMatch(java.util.ArrayList<java.lang.String> compareWith, java.util.ArrayList<java.lang.String> keywords) Compare the keyword lists and check that both contain the same keywords.

Methods inherited from class java.lang.Object

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

Constructor Detail

MatchKeywords

public MatchKeywords()

Create a new instance of MatchKeywords.

Method Detail

compareMetadata

public float compareMetadata(java.util.ArrayList<java.lang.String> compareWith,
                             java.util.ArrayList<java.lang.String> keywords,
                             java.lang.String matchType)
                      throws java.lang.Exception

Compare the metadata as keyword lists and return the result. There are five default structures that get checked, as follows:

1. MetaConst.ANYSTRUCTURE: returns 1.0 for any match.
2. MetaConst.ALLPARTIAL: the keyword must be present in both lists but a matching position is not required. Returns 1.0 for a full match or 0.5 if values or parts of values are missing.
3. MetaConst.ALLEXACT: the keyword must be present in both lists and also in the same position. Returns 1.0 for a full match or 0.5 if values or parts of values are missing.

Parameters:

compareWith - the list of keywords to compare with.

keywords - the list of keywords.

matchType - the type of matching process. If null, then MetaConst.ALLEXACT is used.

Returns:

a value indicating how well the metadata matches.

Throws:

java.lang.Exception - any error.

compareKeywords

protected float compareKeywords(java.util.ArrayList<java.lang.String> compareWith,
                                java.util.ArrayList<java.lang.String> keywords)

Compare the keyword lists and check for similarity. This includes the position in each list.

Parameters:

compareWith - this is the list to compare with. Each item is a word name that can be in order.

keywords - the word or keyword list. This has the same list structure.

Returns:

a value representing how similar the analyses are.

compareKeywordCounts

public float compareKeywordCounts(java.util.ArrayList<java.lang.String[]> compareWith,
                                  java.util.ArrayList<java.lang.String[]> keywords)

Compare the word counts in the model passed in with this one. This is the standard way to score the similarities between the keyword counts. It checks for equal terms but also considers count differences in those terms. The term order is also considered, for example position 1 against position 10, etc.

Parameters:

compareWith - the word or term list to compare with. Each item is an array, where the first element is the word name and the second is a frequency count for the word. The frequency count is then converted into a number.

keywords - this is the list of keywords and counts. This has the same count structure.

Returns:

a value representing how similar the analyses are.

listsMatch

public float listsMatch(java.util.ArrayList<java.lang.String> compareWith,
                        java.util.ArrayList<java.lang.String> keywords)
                 throws java.lang.Exception

Compare the keyword lists and check that both contain the same keywords.

Parameters:

compareWith - this is the list to compare with. Each item is a word name that can be in order.

keywords - the word or keyword list. This has the same list structure.

Returns:

1.0 for exact match, less than 1 for partial math, 0 for no match at all.

Throws:

java.lang.Exception - any error.