com.yahoo.document.datatypes

Class WeightedSet<K extends FieldValue>

java.lang.Object

com.yahoo.vespa.objects.Selectable

com.yahoo.vespa.objects.Identifiable

com.yahoo.document.datatypes.FieldValue

com.yahoo.document.datatypes.CompositeFieldValue

com.yahoo.document.datatypes.CollectionFieldValue<K>

com.yahoo.document.datatypes.WeightedSet<K>

All Implemented Interfaces:

Cloneable, Comparable<FieldValue>, Map<K,Integer>

public final class WeightedSet<K extends FieldValue>
extends CollectionFieldValue<K>
implements Map<K,Integer>

A weighted set, a unique set of keys with an associated integer weight. This class uses an encapsulated Map (actually a LinkedHashMap) that associates each key with its weight (value).

Author:

Einar M R Rosenvinge

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	WeightedSet.WeightedSetWrapper Weighted set MapFieldValue, backed by map of native Java types.

Nested classes/interfaces inherited from class com.yahoo.document.datatypes.FieldValue

FieldValue.RecursiveIteratorHandler

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
private MapFieldValue<K,IntegerFieldValue>	map

Fields inherited from class com.yahoo.document.datatypes.FieldValue

classId

Constructor Summary

Constructors

Constructor and Description
WeightedSet(DataType type) Creates a new WeightedSet.
WeightedSet(DataType type, int initialCapacity) Creates a new weighted set with a given initial capacity.

Method Summary

Modifier and Type	Method and Description
boolean	add(K value)
void	assign(Object o) Assign this non-fieldvalue value to this field value.
void	clear() Remove all key-weight associations in this set.
void	clearAndReserve(int count) Reserve space for this amount of keys in order to avoid resizing
WeightedSet	clone()
int	compareTo(FieldValue fieldValue)
boolean	contains(Object o)
boolean	containsKey(Object key) Checks whether this set contains the specified key.
boolean	containsValue(Object value)
void	deserialize(Field field, FieldReader reader) Read a field value from the specified reader
Set<Map.Entry<K,Integer>>	entrySet()
boolean	equals(Object o) Checks if another object is equal to this set.
Iterator<K>	fieldValueIterator()
Integer	get(Object key) Returns the weight associated with the specified key.
WeightedSetDataType	getDataType()
(package private) Map<K,Integer>	getPrimitiveMap()
Object	getWrappedValue() Used to retrieve wrapped type for simple types, such that you can use get methods to retrieve ints and floats directly instead of Int/Float field values.
int	hashCode() Uses hashCode() from the encapsulated Map.
boolean	isEmpty() Checks if this set is empty.
(package private) FieldPathIteratorHandler.ModificationStatus	iterateNested(FieldPath fieldPath, int pos, FieldPathIteratorHandler handler) Iterates through the document using the given fieldpath, calling callbacks in the given iterator handler.
Iterator<K>	iterator()
Set<K>	keySet()
void	printXml(XmlStream xml)
Integer	put(K key, Integer weight) Add a key with an associated weight to this set.
void	putAll(Map<? extends K,? extends Integer> t)
IntegerFieldValue	putUnChecked(K key, IntegerFieldValue weight) Add a key with an associated weight to this set.
Integer	remove(Object key) Remove a key-weight association from this set.
boolean	removeValue(FieldValue o)
void	serialize(Field field, FieldWriter writer) Write out field value to the specified writer
int	size() Returns the number of key-weight pairs in this set.
String	toString() Uses toString() from the encapsulated Map.
Collection<Integer>	values()

Methods inherited from class com.yahoo.document.datatypes.CollectionFieldValue

createFieldValue, isEmpty, removeValue, verifyElementCompatibility

Methods inherited from class com.yahoo.document.datatypes.CompositeFieldValue

setDataType

Methods inherited from class com.yahoo.document.datatypes.FieldValue

checkAssign, create, deserialize, getRecursiveValue, getRecursiveValue, onDeserialize, onSerialize, serialize, toXml

Methods inherited from class com.yahoo.vespa.objects.Identifiable

create, createFromId, deserialize, deserializeOptional, deserializeWithId, equals, getClassId, getUtf8, onGetClassId, putUtf8, registerClass, serialize, serializeOptional, serializeWithId, visitMembers

Methods inherited from class com.yahoo.vespa.objects.Selectable

select, select, selectMembers

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

map

private MapFieldValue<K extends FieldValue,IntegerFieldValue> map

Constructor Detail

WeightedSet

public WeightedSet(DataType type)

Creates a new WeightedSet.

Parameters:

type - the data type for the field that this weighted set is associated with

WeightedSet

public WeightedSet(DataType type,
                   int initialCapacity)

Creates a new weighted set with a given initial capacity.

Parameters:

initialCapacity - the initial capacity to use for the encapsulated Map

Method Detail

getDataType

public WeightedSetDataType getDataType()

Overrides:

getDataType in class CollectionFieldValue<K extends FieldValue>

fieldValueIterator

public Iterator<K> fieldValueIterator()

Specified by:

fieldValueIterator in class CollectionFieldValue<K extends FieldValue>

assign

public void assign(Object o)

Description copied from class: FieldValue

Assign this non-fieldvalue value to this field value. This is used to be able to assign ints to Integer field values and List to Array field values and such.

Override to accept the specific types that should be legal.

Specified by:

assign in class FieldValue

clone

public WeightedSet clone()

Overrides:

clone in class FieldValue

printXml

public void printXml(XmlStream xml)

Specified by:

printXml in class FieldValue

size

public int size()

Returns the number of key-weight pairs in this set.

Specified by:

size in interface Map<K extends FieldValue,Integer>

Specified by:

size in class CollectionFieldValue<K extends FieldValue>

Returns:

the number of key-weight pairs in this set

add

public boolean add(K value)

Specified by:

add in class CollectionFieldValue<K extends FieldValue>

getWrappedValue

public Object getWrappedValue()

Description copied from class: FieldValue

Used to retrieve wrapped type for simple types, such that you can use get methods to retrieve ints and floats directly instead of Int/Float field values. Complex types that can't be specified by simple java types just return themself.

Overrides:

getWrappedValue in class FieldValue

contains

public boolean contains(Object o)

Specified by:

contains in class CollectionFieldValue<K extends FieldValue>

isEmpty

public boolean isEmpty()

Checks if this set is empty.

Specified by:

isEmpty in interface Map<K extends FieldValue,Integer>

Specified by:

isEmpty in class CollectionFieldValue<K extends FieldValue>

Returns:

true if the set is empty

iterator

public Iterator<K> iterator()

Specified by:

iterator in class CollectionFieldValue<K extends FieldValue>

removeValue

public boolean removeValue(FieldValue o)

Specified by:

removeValue in class CollectionFieldValue<K extends FieldValue>

containsKey

public boolean containsKey(Object key)

Checks whether this set contains the specified key.

Specified by:

containsKey in interface Map<K extends FieldValue,Integer>

Parameters:

key - the key to search for

Returns:

true if this set contains this key

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K extends FieldValue,Integer>

get

public Integer get(Object key)

Returns the weight associated with the specified key.

Specified by:

get in interface Map<K extends FieldValue,Integer>

Parameters:

key - the key to return the weight for

Returns:

the weight associated with the specified key, or null (if not found)

put

public Integer put(K key,
                   Integer weight)

Add a key with an associated weight to this set. If the key is already present in this set, the previous association is replaced. Checks to validate that all keys are of the same type.

Specified by:

put in interface Map<K extends FieldValue,Integer>

Parameters:

key - the key to add

weight - the weight to associate with this key

Returns:

the weight that was previously associated with this key, or null (if there was no previous key)

putUnChecked

public IntegerFieldValue putUnChecked(K key,
                                      IntegerFieldValue weight)

Add a key with an associated weight to this set. If the key is already present in this set, the previous association is replaced.

Parameters:

key - the key to add

weight - the weight to associate with this key

Returns:

the weight that was previously associated with this key, or null (if there was no previous key)

remove

public Integer remove(Object key)

Remove a key-weight association from this set.

Specified by:

remove in interface Map<K extends FieldValue,Integer>

Parameters:

key - the key to remove

Returns:

the weight that was previously associated with this key, or null (if there was no previous key)

putAll

public void putAll(Map<? extends K,? extends Integer> t)

Specified by:

putAll in interface Map<K extends FieldValue,Integer>

clear

public void clear()

Remove all key-weight associations in this set.

Specified by:

clear in interface Map<K extends FieldValue,Integer>

Specified by:

clear in class FieldValue

clearAndReserve

public void clearAndReserve(int count)

Reserve space for this amount of keys in order to avoid resizing

getPrimitiveMap

Map<K,Integer> getPrimitiveMap()

values

public Collection<Integer> values()

Specified by:

values in interface Map<K extends FieldValue,Integer>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K extends FieldValue,Integer>

entrySet

public Set<Map.Entry<K,Integer>> entrySet()

Specified by:

entrySet in interface Map<K extends FieldValue,Integer>

equals

public boolean equals(Object o)

Checks if another object is equal to this set.

Specified by:

equals in interface Map<K extends FieldValue,Integer>

Overrides:

equals in class CompositeFieldValue

Parameters:

o - the object to check for equality with

Returns:

true if o is an instance of WeightedSet and the two encapsulated Maps are equal, false otherwise

hashCode

public int hashCode()

Uses hashCode() from the encapsulated Map.

Specified by:

hashCode in interface Map<K extends FieldValue,Integer>

Overrides:

hashCode in class CompositeFieldValue

Returns:

the hash code of this set

toString

public String toString()

Uses toString() from the encapsulated Map.

Overrides:

toString in class com.yahoo.vespa.objects.Identifiable

Returns:

the toString() of this set

serialize

public void serialize(Field field,
                      FieldWriter writer)

Description copied from class: FieldValue

Write out field value to the specified writer

Specified by:

serialize in class FieldValue

deserialize

public void deserialize(Field field,
                        FieldReader reader)

Description copied from class: FieldValue

Read a field value from the specified reader

Specified by:

deserialize in class FieldValue

iterateNested

FieldPathIteratorHandler.ModificationStatus iterateNested(FieldPath fieldPath,
                                                          int pos,
                                                          FieldPathIteratorHandler handler)

Description copied from class: FieldValue

Iterates through the document using the given fieldpath, calling callbacks in the given iterator handler.

Overrides:

iterateNested in class FieldValue

compareTo

public int compareTo(FieldValue fieldValue)

Specified by:

compareTo in interface Comparable<FieldValue>

Overrides:

compareTo in class FieldValue