Interface Field

All Known Subinterfaces:
CalculatedField, PivotField, UpdateField, ValueHoldingField
All Known Implementing Classes:
DistanceField, FacetOptions.FieldWithDateRangeParameters, FacetOptions.FieldWithFacetParameters, FacetOptions.FieldWithNumericRangeParameters, FacetOptions.FieldWithRangeParameters, FieldWithQueryParameters, HighlightOptions.FieldWithHighlightParameters, SimpleCalculatedField, SimpleField, SimplePivotField, SimpleUpdateField

public interface Field
Defines a Field that can be used within Criteria.
  • Method Summary

    Modifier and Type
    Method
    Description
    static Field
    Create a Field with given alias for the calculated distance.
    Get the name of the field used in schema.xml of solr server
    static Field
    of(String name)
    Create a Field with given name.
    static Field
    pivot(String... names)
    Create a Field for the given names.
  • Method Details

    • getName

      @Nullable String getName()
      Get the name of the field used in schema.xml of solr server
      Returns:
    • of

      static Field of(String name)
      Create a Field with given name.
      Parameters:
      name - must not be null.
      Returns:
      new instance of Field.
      Since:
      4.1
    • pivot

      static Field pivot(String... names)
      Create a Field for the given names.
      Parameters:
      names - must not be null.
      Returns:
      new instance of Field.
      Since:
      4.1
    • distance

      static Field distance(String alias)
      Create a Field with given alias for the calculated distance.
      Parameters:
      alias - the alias to use. must not be null.
      Returns:
      new instance of Field.
      Since:
      4.1