Uses of Class
com.persistit.Key

Packages that use Key

Package	Description
com.persistit	Implements Persistit™'s core functionality.
com.persistit.encoding	Implements extended encoding of objects and strings to and from Keys and Values.

Uses of Key in com.persistit

Fields in com.persistit declared as Key

Modifier and Type	Field and Description
protected Key	StreamLoader._key
protected Key	StreamSaver._lastKey
static Key	Key.LEFT_GUARD_KEY Key that always occupies the left edge of any Tree
static Key	Key.RIGHT_GUARD_KEY Key that always occupies the right edge of any Tree

Methods in com.persistit that return Key

Modifier and Type	Method and Description
Key	Key.append(boolean v) Encodes and appends a boolean value to the key.
Key	Key.append(byte v) Encodes and appends a byte value to the key.
Key	Key.append(char v) Encodes and appends a char value to the key.
Key	Key.append(double v) Encodes and appends a double value to the key.
Key	Key.append(float v) Encodes and appends a float value to the key.
Key	Key.append(int v) Encodes and appends an int value to the key.
Key	Key.append(long v) Encodes and appends a long value to the key.
Key	Key.append(Object object) Encodes and appends an Object value to the key.
Key	Key.append(Object object, CoderContext context) Encodes and appends an Object value to the key.
Key	Key.append(short v) Encodes and appends a short value to the key.
Key	Key.appendByteArray(byte[] bytes, int offset, int size) Append a key segment that encodes a subarray from a supplied array of bytes.
Key	Key.appendKeySegment(Key key) Append the next key segment of the supplied Key to this Key.
Key	Key.clear() Sets the current location and size of this Key to zero, effectively removing any previously appended key segments.
Key	Key.cut() Remove one key segment value from the end of this Key.
Key	Key.cut(int count) Remove up to count key segment values from the end of this Key.
Key	KeyHistogram.getEndKey()
Key	ReadOnlyExchange.getKey() Return the Key associated with this Exchange.
Key	Exchange.getKey() Return the Key associated with this Exchange.
Key	KeyHistogram.getStartKey()
Key	Key.indexTo(int depth) Sets the index to a specified depth.
Key	Key.reset() Sets the index to 0.
Key	Key.setDepth(int depth) Truncates this Key to the specified depth.
Key	Key.setIndex(int index) The index is the next position in the backing byte array from which a segment value will be decoded.
Key	Key.to(boolean v) Replaces the final key segment with the supplied boolean value.
Key	Key.to(byte v) Replaces the final key segment with the supplied byte value.
Key	Key.to(char v) Replaces the final key segment with the supplied char value.
Key	Key.to(double v) Replaces the final key segment with the supplied double value.
Key	Key.to(float v) Replaces the final key segment with the supplied float value.
Key	Key.to(int v) Replaces the final key segment with the supplied int value.
Key	Key.to(long v) Replaces the final key segment with the supplied long value.
Key	Key.to(Object v) Replaces the final key segment with the supplied Object value.
Key	Key.to(short v) Replaces the final key segment with the supplied short value.

Methods in com.persistit with parameters of type Key

Modifier and Type	Method and Description
Key	Key.appendKeySegment(Key key) Append the next key segment of the supplied Key to this Key.
void	DefaultObjectCoder.appendKeySegment(Key key, Object object, CoderContext context)
int	Key.compareKeyFragment(Key key, int fragmentStart, int fragmentSize) Compare a bounded subarray of the backing byte array for this Key with another Key.
int	Key.compareKeySegment(Key key) Compare the next key segment of this key to the next key segment of the supplied Key.
KeyHistogram	Exchange.computeHistogram(Key start, Key end, int sampleSize, int keyDepth, KeyFilter keyFilter, int requestedTreeDepth)
void	KeyState.copyTo(Key key) Copy the content of this KeyState to the supplied Key.
void	Key.copyTo(Key key) Copies all state information from this to the supplied Key.
Object	DefaultObjectCoder.decodeKeySegment(Key key, Class clazz, CoderContext context)
protected boolean	TreeBuilder.duplicateKeyDetected(Tree tree, Key key, Value v1, Value v2) This method may be extended to provide application-specific behavior when an attempt is made to merge records with duplicate keys.
int	Key.firstUniqueByteIndex(Key key) Returns the index of the first encoded byte of this key that is different than the corresponding byte of the supplied Key.
int	Key.firstUniqueSegmentDepth(Key key) Returns the depth of the first segment of this key that is different than the corresponding byte of the supplied Key.
protected void	StreamLoader.ImportHandler.handleDataRecord(Key key, Value value)
void	Exchange.lock(Key key) Invoke Exchange.lock(Key, long) with the supplied key and a default timeout value of 60000L milliseconds.
void	Exchange.lock(Key lockKey, long timeout) Within a transaction, enforces a constraint that no other concurrent transaction also successfully locks the same key.
boolean	KeyFilter.next(Key key, Key.Direction direction) Determine the next key value from which B-Tree traversal should proceed.
boolean	KeyParser.parseKey(Key key) Parse a key value from the string or substring from which this KeyParser was constructed, modifying the supplied Key to contain the result.
boolean	Exchange.removeKeyRange(Key key1, Key key2) Removes all records with keys falling between key1 and key2, left-inclusive.
void	DefaultObjectCoder.renderKeySegment(Key key, Object target, Class clazz, CoderContext context) Populates the state of the supplied target Object by decoding the next key segment of the supplied Key.
boolean	KeyFilter.selected(Key key) Indicates whether the supplied key is selected by this filter.
void	TreeBuilder.store(Tree tree, Key key, Value value) Store a key-value pair for a specified Tree into a sort tree.
static KeyFilter.Term	KeyFilter.termFromKeySegments(Key fromKey, Key toKey, boolean leftInclusive, boolean rightInclusive) Returns a Term that accepts a range of values.
protected void	StreamSaver.writeData(Key key, Value value) Writes a key/value pair into a DATA record.

Constructors in com.persistit with parameters of type Key

Constructor and Description
Key(Key source) Constructs a Key which duplicates the state of the supplied Key.
KeyFilter(Key key) Constructs a KeyFilter that selects the subset of all keys which are equal to, logical children of, or logical ancestors of the supplied Key.
KeyFilter(Key key, int minDepth, int maxDepth) Constructs a KeyFilter that selects the subset of all key values that are equal to, logical children of, or logical ancestors of the supplied Key, and whose depth is greater than or equal to the supplied minimum depth and less than or equal to the supplied maximum depth.
KeyHistogram(Tree tree, Key start, Key end, int sampleSize, int keyDepth, int treeDepth)
KeyState(Key key) Construct an immutable KeyState by copying the relevant state information from a Key.

Uses of Key in com.persistit.encoding

Methods in com.persistit.encoding with parameters of type Key

Modifier and Type	Method and Description
void	KeyCoder.appendKeySegment(Key key, Object object, CoderContext context) Append a key segment derived from an object to a Key.
Object	KeyCoder.decodeKeySegment(Key key, Class<?> clazz, CoderContext context) Decode a key segment as an Object value.
void	KeyDisplayer.displayKeySegment(Key key, Appendable target, Class<?> clazz, CoderContext context) Populates the state of the supplied target Object by decoding the next key segment of the supplied Key.
Object	ObjectCache.get(Key key) Return the Object value associated with the key if it is present in the cache; otherwise null.
Object	ObjectCache.getWithNull(Key key) Return the Object value associated with the key if it is present in the cache; otherwise null.
boolean	ObjectCache.isCached(Key key) Indicates whether there is a value associated with the key.
Object	ObjectCache.put(Key key, Object value) Inserts a key/value pair in the cache and returns the formerly cached value, if there is one.
Object	ObjectCache.remove(Key key) Remove the entry for the specified key, if present, and return its former value.
void	KeyRenderer.renderKeySegment(Key key, Object target, Class<?> clazz, CoderContext context) Populate the state of the supplied target Object by decoding the next key segment of the supplied Key.