Interface Document

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    DefaultDocument

    public interface Document
    extends java.io.Serializable
    This interface represents a search result document.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Collection<java.lang.String> getFieldNames()
      Returns the field names defined in this document.
      java.util.Map<java.lang.String,​java.lang.Object> getFields()
      Returns the fields defined in this document.
      java.lang.Object getFieldValue​(java.lang.String fieldName)
      Returns the value or collection of values for a given field.
      java.util.Set<java.lang.String> getTags()
      Returns the tags defined in this document.
    • Method Detail

      • getFieldNames

        java.util.Collection<java.lang.String> getFieldNames()
        Returns the field names defined in this document.
        Returns:
        the field names defined in this document
      • getFieldValue

        java.lang.Object getFieldValue​(java.lang.String fieldName)
        Returns the value or collection of values for a given field.
        Returns:
        the value or collection of values for a given field
      • getFields

        java.util.Map<java.lang.String,​java.lang.Object> getFields()
        Returns the fields defined in this document.
        Returns:
        the fields defined in this document
      • getTags

        java.util.Set<java.lang.String> getTags()
        Returns the tags defined in this document.
        Returns:
        the tags defined in this document