com.davidbracewell.hermes

Interface AttributedObject

All Known Implementing Classes:

Annotation, Document, HString

public interface AttributedObject

An AttributedObject is an object that has zero or more attributes associated with it. An attribute may represent a learned annotation (e.g. part of speech or word sense), metadata (e.g. author or source url), or a feature (e.g. suffix or phonetic encoding).

Author:

David B. Bracewell

Method Summary

Modifier and Type	Method and Description
Set<AttributeType>	attributes() Gets the attributes associated with the object
Set<Map.Entry<AttributeType,com.davidbracewell.conversion.Val>>	attributeValues() Gets the set of attributes and values associated with the object.
boolean	contains(AttributeType attributeType) Determines if an attribute of a given name is associated with the object
com.davidbracewell.conversion.Val	get(AttributeType attributeType) Gets the value for a given attribute name
default <T> T	get(AttributeType attributeType, Class<T> clazz)
default double	getAttributeAsDouble(AttributeType attributeType)
default int	getAttributeAsInt(AttributeType attributeType)
default <T> List<T>	getAttributeAsList(AttributeType attributeType)
default <K,V> Map<K,V>	getAttributeAsMap(AttributeType attributeType)
default <T> Set<T>	getAttributeAsSet(AttributeType attributeType)
default String	getAttributeAsString(AttributeType attributeType)
default <T extends com.davidbracewell.Tag> T	getAttributeAsTag(AttributeType attributeType)
com.davidbracewell.conversion.Val	put(AttributeType attributeType, Object value) Sets the value of an attribute.
default void	putAll(Map<AttributeType,?> map) Sets all attributes in a given map.
default com.davidbracewell.conversion.Val	putIfAbsent(AttributeType attributeType, Object value) Sets the value of an attribute if a value is not already set.
default com.davidbracewell.conversion.Val	putIfAbsent(AttributeType attributeType, Supplier<?> supplier) Sets the value of an attribute if a value is not already set.
com.davidbracewell.conversion.Val	remove(AttributeType attributeType) Removes an attribute from the object.

Method Detail

attributeValues

Set<Map.Entry<AttributeType,com.davidbracewell.conversion.Val>> attributeValues()

Gets the set of attributes and values associated with the object.

Returns:

the attributes and their values

attributes

Set<AttributeType> attributes()

Gets the attributes associated with the object

Returns:

the attributes associated with the object.

contains

boolean contains(AttributeType attributeType)

Determines if an attribute of a given name is associated with the object

Parameters:

attributeType - The attribute name

Returns:

True if the attribute is associated with the object, False otherwise

get

com.davidbracewell.conversion.Val get(AttributeType attributeType)

Gets the value for a given attribute name

Parameters:

attributeType - the attribute name

Returns:

the value associated with the attribute or null

get

default <T> T get(@NonNull
                  AttributeType attributeType,
                  @NonNull
                  Class<T> clazz)

getAttributeAsInt

default int getAttributeAsInt(@NonNull
                              AttributeType attributeType)

getAttributeAsDouble

default double getAttributeAsDouble(@NonNull
                                    AttributeType attributeType)

getAttributeAsString

default String getAttributeAsString(@NonNull
                                    AttributeType attributeType)

getAttributeAsList

default <T> List<T> getAttributeAsList(@NonNull
                                       AttributeType attributeType)

getAttributeAsTag

default <T extends com.davidbracewell.Tag> T getAttributeAsTag(@NonNull
                                                               AttributeType attributeType)

getAttributeAsSet

default <T> Set<T> getAttributeAsSet(@NonNull
                                     AttributeType attributeType)

getAttributeAsMap

default <K,V> Map<K,V> getAttributeAsMap(@NonNull
                                         AttributeType attributeType)

put

com.davidbracewell.conversion.Val put(AttributeType attributeType,
                                      Object value)

Sets the value of an attribute. Removes the attribute if the value is null and ignores setting a value if the attribute is null.

Parameters:

attributeType - the attribute name

value - the value

Returns:

The old value of the attribute or null

putIfAbsent

default com.davidbracewell.conversion.Val putIfAbsent(AttributeType attributeType,
                                                      Object value)

Sets the value of an attribute if a value is not already set. Removes the attribute if the value is null and ignores setting a value if the attribute is null.

Parameters:

attributeType - the attribute name

value - the value

Returns:

The old value of the attribute or null

putIfAbsent

default com.davidbracewell.conversion.Val putIfAbsent(AttributeType attributeType,
                                                      @NonNull
                                                      Supplier<?> supplier)

Sets the value of an attribute if a value is not already set. Removes the attribute if the value is null and ignores setting a value if the attribute is null.

Parameters:

attributeType - the attribute name

supplier - the supplier to generate the new value

Returns:

The old value of the attribute or null

putAll

default void putAll(Map<AttributeType,?> map)

Sets all attributes in a given map.

Parameters:

map - the attribute-value map

remove

com.davidbracewell.conversion.Val remove(AttributeType attributeType)

Removes an attribute from the object.

Parameters:

attributeType - the attribute name

Returns:

the value that was associated with the attribute