forked from IQSS/dataverse
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(index): make SolrFieldProperty an enum of possible properties.
- Loading branch information
1 parent
c00c6ca
commit 103493c
Showing
1 changed file
with
46 additions
and
114 deletions.
There are no files selected for viewing
160 changes: 46 additions & 114 deletions
160
src/main/java/edu/harvard/iq/dataverse/search/schema/SolrFieldProperty.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,125 +1,57 @@ | ||
| package edu.harvard.iq.dataverse.search.schema; | ||
|
|
||
| import java.util.Objects; | ||
| import java.util.Optional; | ||
|
|
||
| /** | ||
| * A POJO class to hold information about {@link SolrFieldType} or {@link SolrField} properties, using typed responses. | ||
| * This is currently Solr specific, which only allows for lots of boolean and some other properties (using String here | ||
| * to reduce complexity). | ||
| * @param <T> The factory methods will only allow for {@link Boolean} or {@link String} types. | ||
| */ | ||
| public class SolrFieldProperty<T> { | ||
|
|
||
| private final String name; | ||
| private final T defaultValue; | ||
| private T value; | ||
|
|
||
| private SolrFieldProperty(String name, T value, T defaultValue) { | ||
| this.name = name; | ||
| this.value = value; | ||
| this.defaultValue = defaultValue; | ||
| } | ||
|
|
||
| /** | ||
| * Method to create a property without an explicit default. | ||
| * @param name The name of the property | ||
| * @param value The value of the property, in this case has to be typed {@link Boolean}. | ||
| * @return A property field | ||
| * @throws IllegalArgumentException if name or value is null. | ||
| */ | ||
| public static SolrFieldProperty<Boolean> bool(String name, Boolean value) { | ||
| return bool(name, value, null); | ||
| } | ||
| /** | ||
| * Method to create a property with an explicit default. The value might be omitted. | ||
| * @param name The name of the property | ||
| * @param value The value of the property, in this case has to be typed {@link Boolean}. | ||
| * @param defaultValue The default value of the property when no value present, in this case has to be typed {@link Boolean}. | ||
| * @return A property field | ||
| * @throws IllegalArgumentException if name or (value AND default value) is null. | ||
| */ | ||
| public static SolrFieldProperty<Boolean> bool(String name, Boolean value, Boolean defaultValue) { | ||
| if ( name == null ) | ||
| throw new IllegalArgumentException("Name cannot be null."); | ||
| if ( value == null && defaultValue == null) | ||
| throw new IllegalArgumentException("Value and defaultValue cannot both be null."); | ||
| return new SolrFieldProperty<>(name, value, defaultValue); | ||
| } | ||
|
|
||
| /** | ||
| * Method to create a property without an explicit default. | ||
| * @param name The name of the property | ||
| * @param value The value of the property, in this case has to be typed {@link String}. | ||
| * @return A property field | ||
| * @throws IllegalArgumentException if name or value is null. | ||
| */ | ||
| public static SolrFieldProperty<String> string(String name, String value) { | ||
| return string(name, value, null); | ||
| } | ||
| /** | ||
| * Method to create a property with an explicit default. The value might be omitted. | ||
| * @param name The name of the property | ||
| * @param value The value of the property, in this case has to be typed {@link String}. | ||
| * @param defaultValue The default value of the property when no value present, in this case has to be typed {@link String}. | ||
| * @return A property field | ||
| * @throws IllegalArgumentException if name or (value AND default value) is null. | ||
| */ | ||
| public static SolrFieldProperty<String> string(String name, String value, String defaultValue) { | ||
| if ( name == null ) | ||
| throw new IllegalArgumentException("Name cannot be null."); | ||
| if ( value == null && defaultValue == null) | ||
| throw new IllegalArgumentException("Value and defaultValue cannot both be null."); | ||
| return new SolrFieldProperty<>(name, value, defaultValue); | ||
| public enum SolrFieldProperty { | ||
| NAME("name", String.class, null), | ||
| CLASS("class", String.class, null), | ||
| TYPE("type", String.class, null), | ||
| DEFAULT("default", String.class, null), | ||
|
|
||
| POSITIONINCREMENTGAP("positionIncrementGap", String.class, null), | ||
| AUTOGENERATEPHRASEQUERIES("autoGeneratePhraseQueries", Boolean.class, null), | ||
| SYNONYMQUERYSTYLE("synonymQueryStyle", String.class, null), | ||
| ENABLEGRAPHQUERIES("enableGraphQueries", Boolean.class, "true"), | ||
| DOCVALUESFORMAT("docValuesFormat", String.class, null), | ||
| POSTINGSFORMAT("postingsFormat", String.class, null), | ||
|
|
||
| INDEXED("indexed", Boolean.class, "true"), | ||
| STORED("stored", Boolean.class, "true"), | ||
| DOCVALUES("docValues", Boolean.class, "false"), | ||
| SORTMISSINGFIRST("sortMissingFirst", Boolean.class, "false"), | ||
| SORTMISSINGLAST("sortMissingLast", Boolean.class, "false"), | ||
| MULTIVALUED("multiValued", Boolean.class, "false"), | ||
| UNINVERTIBLE("uninvertible", Boolean.class, "true"), | ||
| OMITNORMS("omitNorms", Boolean.class, null), | ||
| OMITTERMFREQANDPOSITIONS("omitTermFreqAndPositions", Boolean.class, null), | ||
| OMITPOSITIONS("omitPositions", Boolean.class, null), | ||
| TERMVECTORS("termVectors", Boolean.class, "false"), | ||
| TERMPOSITIONS("termPositions", Boolean.class, "false"), | ||
| TERMOFFSETS("termOffsets", Boolean.class, "false"), | ||
| TERMPAYLOADS("termPayloads", Boolean.class, "false"), | ||
| REQUIRED("required", Boolean.class, "false"), | ||
| USEDOCVALUESASSTORED("useDocValuesAsStored", Boolean.class, "true"), | ||
| LARGE("large", Boolean.class, "false"); | ||
|
|
||
|
|
||
| public final String fieldName; | ||
| public final Class type; | ||
| public final Optional<String> defaultValue; | ||
|
|
||
| SolrFieldProperty(String fieldName, Class type, String defaultValue) { | ||
| this.fieldName = fieldName; | ||
| this.type = type; | ||
| this.defaultValue = Optional.ofNullable(defaultValue); | ||
| } | ||
|
|
||
| public String getName() { | ||
| return name; | ||
| return fieldName; | ||
| } | ||
|
|
||
| /** | ||
| * Check if the value has been set (!= null). | ||
| * @return true if set, false if not set. | ||
| */ | ||
| public boolean isSet() { | ||
| return value != null; | ||
| public Class getType() { | ||
| return type; | ||
| } | ||
|
|
||
| /** | ||
| * Return value or defaultValue. Guaranteed not to be null, as not both can be null. | ||
| * @return The value or the default value. | ||
| */ | ||
| public T getValue() { | ||
| return value == null ? defaultValue : value; | ||
| } | ||
|
|
||
| /** | ||
| * Set the value of this property to a different value. Will not allow setting to null if | ||
| * no default value is present. | ||
| * @param value The new value (may be null) | ||
| * @throws IllegalArgumentException if value is null and no default was set during creation. | ||
| */ | ||
| public void setValue(T value) { | ||
| if (value == null && defaultValue == null) | ||
| throw new IllegalArgumentException("Value and defaultValue cannot both be null."); | ||
| this.value = value; | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(name, value, defaultValue); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) return true; | ||
| if (o == null || getClass() != o.getClass()) return false; | ||
| SolrFieldProperty<?> that = (SolrFieldProperty<?>) o; | ||
| // only compare the name - we want sets to contain unique properties, distinguished by their name! | ||
| return Objects.equals(name, that.name); | ||
| public Optional<String> getDefault() { | ||
| return defaultValue; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return "["+name+": "+getValue().toString()+"]"; | ||
| } | ||
| } |