Package org.springframework.data.solr.core.mapping

Interface SolrPersistentProperty

All Superinterfaces:
org.springframework.data.mapping.PersistentProperty<SolrPersistentProperty>
All Known Implementing Classes:
SimpleSolrPersistentProperty
public interface SolrPersistentProperty extends org.springframework.data.mapping.PersistentProperty<SolrPersistentProperty>

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    SolrPersistentProperty.PropertyToFieldNameConverter
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsWildcard()
     
    Collection<String>
    getCopyFields()
     
    Object
    getDefaultValue()
     
    String
    getFieldName()
    Get name of field under attention to Field annotation
    String
    getSolrTypeName()
     
    boolean
    isChildProperty()
     
    boolean
    isDynamicProperty()
    Returns whether the property should be handled as dynamic property.
    boolean
    isMultiValued()
     
    boolean
    isReadonly()
     
    boolean
    isRequired()
     
    boolean
    isScoreProperty()
    Returns whether the property is a potential score property of the owning PersistentEntity.
    boolean
    isSearchable()
     
    boolean
    isStored()
     
    boolean
    isUnique()
     

    Methods inherited from interface org.springframework.data.mapping.PersistentProperty

    findAnnotation, findPropertyOrOwnerAnnotation, getAccessorForOwner, getActualType, getAssociation, getAssociationTargetType, getAssociationTargetTypeInformation, getComponentType, getField, getGetter, getMapValueType, getName, getOwner, getPersistentEntityTypeInformation, getRawType, getRequiredAnnotation, getRequiredAssociation, getRequiredField, getRequiredGetter, getRequiredSetter, getRequiredWither, getSetter, getSpelExpression, getType, getTypeInformation, getWither, hasActualTypeAnnotation, isAnnotationPresent, isArray, isAssociation, isCollectionLike, isEntity, isIdProperty, isImmutable, isMap, isTransient, isVersionProperty, isWritable, usePropertyAccess

  • Method Details

    • getFieldName

      String getFieldName()
      Get name of field under attention to Field annotation
      Returns:

    • isReadonly

      boolean isReadonly()
      Returns:
      true if Field is present and not marked Indexed.readonly() = true

    • containsWildcard

      boolean containsWildcard()
      Returns:
      true if Field.value() contains *

    • isSearchable

      boolean isSearchable()
      Returns:
      true if property shall be indexed in solr.
      Since:
      1.3

    • isStored

      boolean isStored()
      Returns:
      true if property shall be stored and returned in result documents.
      Since:
      1.3

    • isMultiValued

      boolean isMultiValued()
      Returns:
      true if property is collection like
      Since:
      1.3
      See Also:
      • PersistentProperty.isCollectionLike()

    • getSolrTypeName

      @Nullable String getSolrTypeName()
      Returns:
      mapped solr type name
      Since:
      1.3

    • getDefaultValue

      @Nullable Object getDefaultValue()
      Since:
      1.3

    • getCopyFields

      Collection<String> getCopyFields()
      Returns:
      list of fields the current fields value shall be copied to
      Since:
      1.3

    • isUnique

      boolean isUnique()
      Returns:
      Since:
      1.3

    • isRequired

      boolean isRequired()
      Returns:
      Since:
      1.3

    • isScoreProperty

      boolean isScoreProperty()
      Returns whether the property is a potential score property of the owning PersistentEntity. This method is mainly used by PersistentEntity implementation to discover score property candidates on PersistentEntity creation you should rather call to determine whether the current property is the score property of that PersistentEntity under consideration.
      Returns:
      Since:
      1.4

    • isDynamicProperty

      boolean isDynamicProperty()
      Returns whether the property should be handled as dynamic property.
      Returns:
      Since:
      1.5
      See Also:

    • isChildProperty

      boolean isChildProperty()
      Returns:
      true if property has set annotation Field.child() to true or is annotated with ChildDocument.
      Since:
      3.0