de.tud.ke.mrapp.rulelearning.core.model

Interface AttributeMap

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

GroundTruth, Instance

All Known Implementing Classes:

AttributeHashMap, TrainingInstance

public interface AttributeMap
extends java.io.Serializable

Defines the interface, a class that maps Attributes to certain values, must implement.

Since:

0.1.0

Method Summary

Modifier and Type	Method and Description
default boolean	contains(@NotNull Attribute attribute) Returns, whether a value is associated with a specific Attribute, or not.
default boolean	contains(int attributeIndex) Returns, whether a value is associated with the Attribute with a specific index, or not.
default @Nullable java.lang.Double	getValue(@NotNull Attribute attribute) Returns the value that is associated with a specific Attribute, if available.
@Nullable java.lang.Double	getValue(int attributeIndex) Returns the value that is associated with the Attribute with a specific index.
default boolean	isEmpty() Returns, whether the map is empty, or not.
int	size() Returns the number of attribute-value mappings that are contained by the map.

Method Detail

isEmpty

default boolean isEmpty()

Returns, whether the map is empty, or not.

Returns:

True, if the map is empty, false otherwise

size

int size()

Returns the number of attribute-value mappings that are contained by the map.

Returns:

The number of attribute-value mappings that are contained by the map

contains

default boolean contains(@NotNull
                         @NotNull Attribute attribute)

Returns, whether a value is associated with a specific Attribute, or not.

Parameters:

attribute - The attribute to be checked

Returns:

True, if a value is associated with the given attribute, false otherwise

contains

default boolean contains(int attributeIndex)

Returns, whether a value is associated with the Attribute with a specific index, or not.

Parameters:

attributeIndex - The index of the attribute to be checked

Returns:

True, if a value is associated with the given attribute, false otherwise

getValue

@Nullable
default @Nullable java.lang.Double getValue(@NotNull
                                                      @NotNull Attribute attribute)

Returns the value that is associated with a specific Attribute, if available.

Parameters:

attribute - The attribute for which the associated value should be returned

Returns:

The value that is associated with the given attribute or null, if no such value is available

getValue

@Nullable
@Nullable java.lang.Double getValue(int attributeIndex)

Returns the value that is associated with the Attribute with a specific index.

Parameters:

attributeIndex - The index of the attribute for which the associated value should be returned

Returns:

The value that is associated with the given attribute or null, if no such value is available