Package org.elasticsearch.common.xcontent.support

Class XContentMapValues

java.lang.Object
org.elasticsearch.common.xcontent.support.XContentMapValues
public class XContentMapValues
extends java.lang.Object

  • Constructor Summary

    Constructors 
    Constructor Description
    XContentMapValues()  

  • Method Summary

    Modifier and Type Method Description
    static java.util.List<java.lang.Object> extractRawValues​(java.lang.String path, java.util.Map<java.lang.String,​java.lang.Object> map)
    Extracts raw values (string, int, and so on) based on the path provided returning all of them as a single list.
    static java.lang.Object extractValue​(java.lang.String path, java.util.Map<?,​?> map)
    For the provided path, return its value in the xContent map.
    static java.lang.Object extractValue​(java.lang.String path, java.util.Map<?,​?> map, java.lang.Object nullValue)
    For the provided path, return its value in the xContent map.
    static java.lang.Object extractValue​(java.util.Map<?,​?> map, java.lang.String... pathElements)  
    static java.util.function.Function<java.util.Map<java.lang.String,​?>,​java.util.Map<java.lang.String,​java.lang.Object>> filter​(java.lang.String[] includes, java.lang.String[] excludes)
    Returns a function that filters a document map based on the given include and exclude rules.
    static java.util.Map<java.lang.String,​java.lang.Object> filter​(java.util.Map<java.lang.String,​?> map, java.lang.String[] includes, java.lang.String[] excludes)
    Only keep properties in map that match the includes but not the excludes.
    static boolean isArray​(java.lang.Object node)  
    static boolean isObject​(java.lang.Object node)  
    static boolean nodeBooleanValue​(java.lang.Object node)  
    static boolean nodeBooleanValue​(java.lang.Object node, boolean defaultValue)  
    static boolean nodeBooleanValue​(java.lang.Object node, java.lang.String name)  
    static boolean nodeBooleanValue​(java.lang.Object node, java.lang.String name, boolean defaultValue)  
    static byte nodeByteValue​(java.lang.Object node)  
    static byte nodeByteValue​(java.lang.Object node, byte defaultValue)  
    static double nodeDoubleValue​(java.lang.Object node)  
    static double nodeDoubleValue​(java.lang.Object node, double defaultValue)  
    static float nodeFloatValue​(java.lang.Object node)  
    static float nodeFloatValue​(java.lang.Object node, float defaultValue)  
    static int nodeIntegerValue​(java.lang.Object node)  
    static int nodeIntegerValue​(java.lang.Object node, int defaultValue)  
    static long nodeLongValue​(java.lang.Object node)  
    static long nodeLongValue​(java.lang.Object node, long defaultValue)  
    static java.util.Map<java.lang.String,​java.lang.Object> nodeMapValue​(java.lang.Object node, java.lang.String desc)  
    static short nodeShortValue​(java.lang.Object node)  
    static short nodeShortValue​(java.lang.Object node, short defaultValue)  
    static java.lang.String[] nodeStringArrayValue​(java.lang.Object node)
    Returns an array of string value from a node value.
    static java.lang.String nodeStringValue​(java.lang.Object node)
    Returns the Object.toString() value of its input, or null if the input is null
    static java.lang.String nodeStringValue​(java.lang.Object node, java.lang.String defaultValue)  
    static org.elasticsearch.common.unit.TimeValue nodeTimeValue​(java.lang.Object node)  
    static org.elasticsearch.common.unit.TimeValue nodeTimeValue​(java.lang.Object node, org.elasticsearch.common.unit.TimeValue defaultValue)  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • extractRawValues

      public static java.util.List<java.lang.Object> extractRawValues​(java.lang.String path, java.util.Map<java.lang.String,​java.lang.Object> map)
      Extracts raw values (string, int, and so on) based on the path provided returning all of them as a single list.

    • extractValue

      public static java.lang.Object extractValue​(java.lang.String path, java.util.Map<?,​?> map)
      For the provided path, return its value in the xContent map. Note that in contrast with extractRawValues(java.lang.String, java.util.Map<java.lang.String, java.lang.Object>), array and object values can be returned.
      Parameters:
      path - the value's path in the map.
      Returns:
      the value associated with the path in the map or 'null' if the path does not exist.

    • extractValue

      public static java.lang.Object extractValue​(java.util.Map<?,​?> map, java.lang.String... pathElements)

    • extractValue

      public static java.lang.Object extractValue​(java.lang.String path, java.util.Map<?,​?> map, java.lang.Object nullValue)
      For the provided path, return its value in the xContent map. Note that in contrast with extractRawValues(java.lang.String, java.util.Map<java.lang.String, java.lang.Object>), array and object values can be returned.
      Parameters:
      path - the value's path in the map.
      nullValue - a value to return if the path exists, but the value is 'null'. This helps in distinguishing between a path that doesn't exist vs. a value of 'null'.
      Returns:
      the value associated with the path in the map or 'null' if the path does not exist.

    • filter

      public static java.util.Map<java.lang.String,​java.lang.Object> filter​(java.util.Map<java.lang.String,​?> map, java.lang.String[] includes, java.lang.String[] excludes)
      Only keep properties in map that match the includes but not the excludes. An empty list of includes is interpreted as a wildcard while an empty list of excludes does not match anything. If a property matches both an include and an exclude, then the exclude wins. If an object matches, then any of its sub properties are automatically considered as matching as well, both for includes and excludes. Dots in field names are treated as sub objects. So for instance if a document contains a.b as a property and a is an include, then a.b will be kept in the filtered map.

    • filter

      public static java.util.function.Function<java.util.Map<java.lang.String,​?>,​java.util.Map<java.lang.String,​java.lang.Object>> filter​(java.lang.String[] includes, java.lang.String[] excludes)
      Returns a function that filters a document map based on the given include and exclude rules.
      See Also:
      for details

    • isObject

      public static boolean isObject​(java.lang.Object node)

    • isArray

      public static boolean isArray​(java.lang.Object node)

    • nodeStringValue

      public static java.lang.String nodeStringValue​(java.lang.Object node, java.lang.String defaultValue)

    • nodeStringValue

      public static java.lang.String nodeStringValue​(java.lang.Object node)
      Returns the Object.toString() value of its input, or null if the input is null

    • nodeFloatValue

      public static float nodeFloatValue​(java.lang.Object node, float defaultValue)

    • nodeFloatValue

      public static float nodeFloatValue​(java.lang.Object node)

    • nodeDoubleValue

      public static double nodeDoubleValue​(java.lang.Object node, double defaultValue)

    • nodeDoubleValue

      public static double nodeDoubleValue​(java.lang.Object node)

    • nodeIntegerValue

      public static int nodeIntegerValue​(java.lang.Object node)

    • nodeIntegerValue

      public static int nodeIntegerValue​(java.lang.Object node, int defaultValue)

    • nodeShortValue

      public static short nodeShortValue​(java.lang.Object node, short defaultValue)

    • nodeShortValue

      public static short nodeShortValue​(java.lang.Object node)

    • nodeByteValue

      public static byte nodeByteValue​(java.lang.Object node, byte defaultValue)

    • nodeByteValue

      public static byte nodeByteValue​(java.lang.Object node)

    • nodeLongValue

      public static long nodeLongValue​(java.lang.Object node, long defaultValue)

    • nodeLongValue

      public static long nodeLongValue​(java.lang.Object node)

    • nodeBooleanValue

      public static boolean nodeBooleanValue​(java.lang.Object node, java.lang.String name, boolean defaultValue)

    • nodeBooleanValue

      public static boolean nodeBooleanValue​(java.lang.Object node, boolean defaultValue)

    • nodeBooleanValue

      public static boolean nodeBooleanValue​(java.lang.Object node, java.lang.String name)

    • nodeBooleanValue

      public static boolean nodeBooleanValue​(java.lang.Object node)

    • nodeTimeValue

      public static org.elasticsearch.common.unit.TimeValue nodeTimeValue​(java.lang.Object node, org.elasticsearch.common.unit.TimeValue defaultValue)

    • nodeTimeValue

      public static org.elasticsearch.common.unit.TimeValue nodeTimeValue​(java.lang.Object node)

    • nodeMapValue

      public static java.util.Map<java.lang.String,​java.lang.Object> nodeMapValue​(java.lang.Object node, java.lang.String desc)

    • nodeStringArrayValue

      public static java.lang.String[] nodeStringArrayValue​(java.lang.Object node)
      Returns an array of string value from a node value. If the node represents an array the corresponding array of strings is returned. Otherwise the node is treated as a comma-separated string.