SearchEngineTextMatcherEditor.Field (Glazed Lists)

java.lang.Object
- ca.odell.glazedlists.matchers.SearchEngineTextMatcherEditor.Field<E>

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

SearchEngineTextMatcherEditor<E>
```
public static final class SearchEngineTextMatcherEditor.Field<E>
extends java.lang.Object
implements java.io.Serializable
```
A Field object contains information specific to a given field found within the Objects being text matched. Specifically, a Field object describes two distinct things:
1. what the text is that identifies this Field when parsing the input text of the refilter method
2. what TextFilterator to use when extracting all values to text search when matching an Object
For example, the input text "city:Toronto" indicates that the text "Toronto" should only be matched against the values of the "city" field within the Objects being searched. As such, a Field object with "city" as its name and a TextFilterator that only returns the value of the "city" field from the Objects being text matched must be present in the Set of Field objects on the SearchEngineTextMatcherEditor.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

Field(java.lang.String name, TextFilterator<? super E> textFilterator)
Creates a field with a name and TextFilterator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getName()`	Returns the text to be located which uniquely identifies this Field.
`TextFilterator<? super E>`	`getTextFilterator()`	Returns the TextFilterator capable of extracting only the fields that should be considered by SearchTerms using this Field.
`int`	`hashCode()`

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

- Constructor Detail
  - Field
```
public Field(java.lang.String name,
             TextFilterator<? super E> textFilterator)
```
    Creates a field with a name and TextFilterator.
    
    Parameters:
    
    name - uniquely identifies this Field relative to all other registered Field objects
    
    textFilterator - extracts only the field values to be considered when matching a given SearchTerm
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the text to be located which uniquely identifies this Field. For example, if this method returns "city", then filter text of "city:Toronto", when parsed, would construct a SearchTerm for "Toronto" that reports this Field object from SearchTerm.getField().
  - getTextFilterator
```
public TextFilterator<? super E> getTextFilterator()
```
    Returns the TextFilterator capable of extracting only the fields that should be considered by SearchTerms using this Field. It is this TextFilterator that contains the custom logic to return a much smaller subset of the total text-searchable fields on the object. Often the TextFilterators returned by this method only report the value of a single field from the Object being matched.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object