FoundDocumentField
Inheritance: java.lang.Object
public abstract class FoundDocumentField
Represents a found document field.
Learn more
Constructors
| Constructor | Description |
|---|---|
| FoundDocumentField() |
Methods
| Method | Description |
|---|---|
| getFieldName() | Gets the field name. |
| getOccurrenceCount() | Gets the number of occurrences found. |
| getTerms() | Gets the terms found. |
| getTermsOccurrences() | Gets the occurrences of the found terms. |
| getTermSequences() | Gets the term sequences found. |
| getTermSequencesOccurrences() | Gets the occurrences of the found term sequences. |
| toString() | Returns string representation of the found document field. |
| serialize() | Serializes the current instance to a byte array. |
| deserialize(byte[] array) | Deserializes an instance from a byte array. |
FoundDocumentField()
public FoundDocumentField()
getFieldName()
public abstract String getFieldName()
Gets the field name.
Returns: java.lang.String - The field name.
getOccurrenceCount()
public abstract int getOccurrenceCount()
Gets the number of occurrences found.
Returns: int - The number of occurrences found.
getTerms()
public abstract String[] getTerms()
Gets the terms found.
Returns: java.lang.String[] - The terms found.
getTermsOccurrences()
public abstract int[] getTermsOccurrences()
Gets the occurrences of the found terms.
Returns: int[] - The occurrences of the found terms.
getTermSequences()
public abstract String[][] getTermSequences()
Gets the term sequences found.
Returns: java.lang.String[][] - The term sequences found.
getTermSequencesOccurrences()
public abstract int[] getTermSequencesOccurrences()
Gets the occurrences of the found term sequences.
Returns: int[] - The occurrences of the found term sequences.
toString()
public abstract String toString()
Returns string representation of the found document field.
Returns: java.lang.String - A string that represents the found document field.
serialize()
public abstract byte[] serialize()
Serializes the current instance to a byte array.
Returns: byte[] - A byte array representing the current instance.
deserialize(byte[] array)
public static FoundDocumentField deserialize(byte[] array)
Deserializes an instance from a byte array.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| array | byte[] | A byte array to deserialize from. |
Returns: FoundDocumentField - An instance deserialized from a byte array.