Class Uid

java.lang.Object
org.elasticsearch.index.mapper.Uid

public final class Uid
extends java.lang.Object
  • Field Summary

    Fields
    Modifier and Type Field Description
    static char DELIMITER  
    static byte DELIMITER_BYTE  
  • Constructor Summary

    Constructors
    Constructor Description
    Uid​(java.lang.String type, java.lang.String id)  
  • Method Summary

    Modifier and Type Method Description
    static java.lang.String decodeId​(byte[] idBytes)
    Decode an indexed id back to its original form.
    static java.lang.String decodeId​(byte[] idBytes, int offset, int length)
    Decode an indexed id back to its original form.
    static org.apache.lucene.util.BytesRef encodeId​(java.lang.String id)
    Encode an id for storage in the index.
    boolean equals​(java.lang.Object o)  
    int hashCode()  
    java.lang.String id()  
    java.lang.String toString()  
    java.lang.String type()  

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

  • Constructor Details

    • Uid

      public Uid​(java.lang.String type, java.lang.String id)
  • Method Details

    • type

      public java.lang.String type()
    • id

      public java.lang.String id()
    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object
    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object
    • encodeId

      public static org.apache.lucene.util.BytesRef encodeId​(java.lang.String id)
      Encode an id for storage in the index. This encoding is optimized for numeric and base64 ids, which are encoded in a much denser way than what UTF8 would do.
      See Also:
      decodeId(byte[])
    • decodeId

      public static java.lang.String decodeId​(byte[] idBytes)
      Decode an indexed id back to its original form.
      See Also:
      encodeId(java.lang.String)
    • decodeId

      public static java.lang.String decodeId​(byte[] idBytes, int offset, int length)
      Decode an indexed id back to its original form.
      See Also:
      encodeId(java.lang.String)