edu.iu.harp.keyval

Class Key2ValKVPartition<K extends Key,V extends Value>

java.lang.Object

edu.iu.harp.resource.Transferable

edu.iu.harp.resource.Simple

edu.iu.harp.resource.Writable

edu.iu.harp.keyval.KVPartition

edu.iu.harp.keyval.Key2ValKVPartition<K,V>

Direct Known Subclasses:

WordCountPartition

public abstract class Key2ValKVPartition<K extends Key,V extends Value>
extends KVPartition

Key2ValKVPartition manages key-value pairs in which the key and the value are objects

Constructor Summary

Constructors

Constructor and Description
Key2ValKVPartition()

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the partition.
java.lang.Class<K>	getKeyClass() Get the class of the keys
<any>	getKVMap() Get the Object2ObjectOpenHashMap
int	getNumWriteBytes() Get the number of bytes of encoded data
V	getVal(K key) Get the associated value of the key
java.lang.Class<V>	getVClass() Get the class of the values
void	initialize(java.lang.Class<K> kClass, java.lang.Class<V> vClass) Initialize the partition
boolean	isEmpty() Indicates if the partition is empty or not
ValStatus	putKeyVal(K key, V val, ValCombiner<V> combiner) Put the new key-value pair to the partition.
void	read(java.io.DataInput in) Read this from DataInput
V	removeVal(K key) Removes this key and the associated value from this function if it is present.
int	size() Get the number of key-value pairs
void	write(java.io.DataOutput out) Write this to DataOutput

Methods inherited from class edu.iu.harp.resource.Writable

create, encode, forClass, free, getNumEnocdeBytes, newInstance, release

Methods inherited from class java.lang.Object

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

Constructor Detail

Key2ValKVPartition

public Key2ValKVPartition()

Method Detail

initialize

public void initialize(java.lang.Class<K> kClass,
                       java.lang.Class<V> vClass)

Initialize the partition

Parameters:

kClass - the class of Key

vClass - the class of Value

putKeyVal

public ValStatus putKeyVal(K key,
                           V val,
                           ValCombiner<V> combiner)

Put the new key-value pair to the partition. If the key already exists in the partition, combine the original value with the new value; else, add the new key-value pair to the partition

Parameters:

key - the new key

val - the new value

combiner - the combiner

Returns:

the ValStatus

removeVal

public V removeVal(K key)

Removes this key and the associated value from this function if it is present.

Parameters:

key - the key

Returns:

the associated value, or null if no value was present for the given key.

getKeyClass

public java.lang.Class<K> getKeyClass()

Get the class of the keys

Returns:

the class of the keys

getVClass

public java.lang.Class<V> getVClass()

Get the class of the values

Returns:

the class of the values

getVal

public V getVal(K key)

Get the associated value of the key

Parameters:

key - the key

Returns:

the associated value

getKVMap

public <any> getKVMap()

Get the Object2ObjectOpenHashMap

Returns:

the Object2ObjectOpenHashMap

size

public int size()

Get the number of key-value pairs

Returns:

the number of key-value pairs

isEmpty

public boolean isEmpty()

Indicates if the partition is empty or not

Returns:

true if empty, false if not

clear

public void clear()

Clear the partition. All Key objects and Value objects will be cached in freeKeys and freeVales respectively for later reuse

Specified by:

clear in class Writable

getNumWriteBytes

public int getNumWriteBytes()

Get the number of bytes of encoded data

Specified by:

getNumWriteBytes in class Writable

Returns:

number of Bytes

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Write this to DataOutput

Specified by:

write in class Writable

Throws:

java.io.IOException

read

public void read(java.io.DataInput in)
          throws java.io.IOException

Read this from DataInput

Specified by:

read in class Writable

Throws:

java.io.IOException