SRUTerm (SRU/CQL Client 2.3.0-SNAPSHOT API)

java.lang.Object
- eu.clarin.sru.client.SRUTerm

```
public final class SRUTerm
extends Object
```
Class to hold a single entry from a scan response.

See Also:

SRUScanResponse

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getDisplayTerm()`	Get A string to display to the end user in place of the term itself.
`DocumentFragment`	`getExtraTermData()`	Get extra term data for this term.
`int`	`getNumberOfRecords()`	Get the number of records which would me matched by the term.
`String`	`getValue()`	Get the term as it appeared in the index.
`SRUWhereInList`	`getWhereInList()`	Get the flag to indicate the position of the term within the complete term list.
`boolean`	`hasExtraTermData()`	Check, if this term has extra term data attached to it.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getValue
```
public String getValue()
```
    Get the term as it appeared in the index.
    
    Returns:
    
    the value of the term
  - getNumberOfRecords
```
public int getNumberOfRecords()
```
    Get the number of records which would me matched by the term.
    
    Returns:
    
    the number of record or -1 if unknown
  - getDisplayTerm
```
public String getDisplayTerm()
```
    Get A string to display to the end user in place of the term itself.
    
    Returns:
    
    a display string or null if unknown
  - getWhereInList
```
public SRUWhereInList getWhereInList()
```
    Get the flag to indicate the position of the term within the complete term list.
    
    Returns:
    
    the flag or null if unknown
  - getExtraTermData
```
public DocumentFragment getExtraTermData()
```
    Get extra term data for this term.
    
    Returns:
    
    get an instance of DocumentFragment containing the XML fragment for the extra term data from the SRU response or null if none are available
  - hasExtraTermData
```
public boolean hasExtraTermData()
```
    Check, if this term has extra term data attached to it.
    
    Returns:
    
    true if extra term data is attached, false otherwise