Package org.apache.solr.common.params

Class SolrParams

    • Constructor Detail

      • SolrParams

        public SolrParams()

    • Method Detail

      • get

        public abstract String get​(String param)
        Returns the first String value of a param, or null if not set. To get all, call getParams(String) instead.

      • getParams

        public abstract String[] getParams​(String param)
        returns an array of the String values of a param, or null if no mapping for the param exists.

      • getParameterNamesIterator

        public abstract Iterator<String> getParameterNamesIterator()
        Returns an Iterator over the parameter names. If you were to call a getter for this parameter, you should get a non-null value. Since you probably want the value, consider using Java 5 for-each style instead for convenience since a SolrParams implements Iterable.

      • get

        public String get​(String param,
                  String def)
        returns the value of the param, or def if not set

      • required

        public RequiredSolrParams required()
        returns a RequiredSolrParams wrapping this

      • getFieldParam

        public String getFieldParam​(String field,
                            String param)
        returns the String value of the field parameter, "f.field.param", or the value for "param" if that is not set.

      • getFieldParam

        public String getFieldParam​(String field,
                            String param,
                            String def)
        returns the String value of the field parameter, "f.field.param", or the value for "param" if that is not set. If that is not set, def

      • getFieldParams

        public String[] getFieldParams​(String field,
                               String param)
        returns the String values of the field parameter, "f.field.param", or the values for "param" if that is not set.

      • getPrimitiveBool

        public boolean getPrimitiveBool​(String param)
        Returns the boolean value of the param, or false if not set

      • getBool

        public boolean getBool​(String param,
                       boolean def)
        Returns the boolean value of the param, or def if not set

      • getPrimitiveFieldBool

        public boolean getPrimitiveFieldBool​(String field,
                                     String param)
        Returns the boolean value of the field param, or the value for param or the default value of boolean - false

      • getFieldBool

        public boolean getFieldBool​(String field,
                            String param,
                            boolean def)
        Returns the boolean value of the field param, or the value for param, or def if neither is set.

      • getInt

        public Integer getInt​(String param)
        Returns the Integer value of the param, or null if not set Use this method only when you want to be explicit about absence of a value (null) vs the default value for int - zero (0).
        See Also:
        getInt(String, int), getPrimitiveInt(String)

      • getPrimitiveInt

        public int getPrimitiveInt​(String param)
        Returns int value of the the param or default value for int - zero (0) if not set.

      • getInt

        public int getInt​(String param,
                  int def)
        Returns the int value of the param, or def if not set

      • getLong

        public Long getLong​(String param)
        Returns the Long value of the param, or null if not set Use this method only when you want to be explicit about absence of a value (null) vs the default value zero (0 ).
        See Also:
        getLong(String, long)

      • getLong

        public long getLong​(String param,
                    long def)
        Returns the long value of the param, or def if not set

      • getFieldInt

        public Integer getFieldInt​(String field,
                           String param)
        Use this method only when you want to be explicit about absence of a value (null) vs the default value zero (0).
        Returns:
        The int value of the field param, or the value for param or null if neither is set.
        See Also:
        getFieldInt(String, String, int)

      • getFieldInt

        public int getFieldInt​(String field,
                       String param,
                       int def)
        Returns the int value of the field param, or the value for param, or def if neither is set.

      • getFloat

        public Float getFloat​(String param)
        Returns the Float value of the param, or null if not set Use this method only when you want to be explicit about absence of a value (null) vs the default value zero (0.0f ).
        See Also:
        getFloat(String, float)

      • getFloat

        public float getFloat​(String param,
                      float def)
        Returns the float value of the param, or def if not set

      • getDouble

        public Double getDouble​(String param)
        Returns the Float value of the param, or null if not set Use this method only when you want to be explicit about absence of a value (null) vs the default value zero (0.0d ).
        See Also:
        getDouble(String, double)

      • getDouble

        public double getDouble​(String param,
                        double def)
        Returns the float value of the param, or def if not set

      • getPrimitiveFieldFloat

        public float getPrimitiveFieldFloat​(String field,
                                    String param)
        Returns the float value of the field param or the value for param or the default value for float - zero (0.0f)

      • getFieldFloat

        public float getFieldFloat​(String field,
                           String param,
                           float def)
        Returns the float value of the field param, or the value for param, or def if neither is set.

      • getFieldDouble

        public Double getFieldDouble​(String field,
                             String param)
        Returns the float value of the field param. Use this method only when you want to be explicit about absence of a value (null) vs the default value zero (0.0d).
        See Also:
        getDouble(String, double)

      • getFieldDouble

        public double getFieldDouble​(String field,
                             String param,
                             double def)
        Returns the float value of the field param, or the value for param, or def if neither is set.

      • toNamedList

        public NamedList<Object> toNamedList()
        Convert this to a NamedList of unique keys with either String or String[] values depending on how many values there are for the parameter.

      • toQueryString

        public String toQueryString()
        Returns this SolrParams as a properly URL encoded string, starting with "?", if not empty.

      • toLocalParamsString

        public String toLocalParamsString()
        Generates a local-params string of the form 
        {! name=value name2=value2}

      • toString

        public String toString()
        Like toQueryString(), but only replacing enough chars so that the URL may be unambiguously pasted back into a browser. This method can be used to properly log query parameters without making them unreadable.

        Characters with a numeric value less than 32 are encoded. &,=,%,+,space are encoded.

        Overrides:
        toString in class Object