org.dlese.dpc.services.dds.toolkit

Class TermsInfo

java.lang.Object

org.dlese.dpc.services.dds.toolkit.TermsInfo

public class TermsInfo
extends java.lang.Object

Class that holds data about the terms in one or more fields in the index. Wraps the data returned from the ListTerms request to Java Maps and Objects.

Author:

John Weatherley

Constructor Summary

Constructors

Constructor and Description
TermsInfo(java.util.List fields, java.util.Map terms, java.lang.String indexVersion, int totalNumTerms) Constructor for the TermsInfo object

Method Summary

Modifier and Type	Method and Description
java.util.List	getFields() Gets a list of the fields in which the terms reside.
java.lang.String	getIndexVersion() Returns version of the index at the time the request was made.
java.util.Map	getTerms() Returns a Map of TermData Objects, keyed by term String.
int	getTotalNumTerms() Returns the total number of terms found in the given field(s).
java.lang.String	toString() Debugging

Methods inherited from class java.lang.Object

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

Constructor Detail

TermsInfo

public TermsInfo(java.util.List fields,
                 java.util.Map terms,
                 java.lang.String indexVersion,
                 int totalNumTerms)

Constructor for the TermsInfo object

Parameters:

fields - Fields

terms - Terms

indexVersion - Index version

totalNumTerms - Total num terms in given fields

Method Detail

getFields

public java.util.List getFields()

Gets a list of the fields in which the terms reside.

Returns:

The fields value

getTerms

public java.util.Map getTerms()

Returns a Map of TermData Objects, keyed by term String.

Returns:

The terms value

getIndexVersion

public java.lang.String getIndexVersion()

Returns version of the index at the time the request was made.

Returns:

The indexVersion value

getTotalNumTerms

public int getTotalNumTerms()

Returns the total number of terms found in the given field(s).

Returns:

The totalNumTerms value

toString

public java.lang.String toString()

Debugging

Overrides:

toString in class java.lang.Object

Returns:

Stringi representation of the TermsInfo object