com.redhat.thermostat.storage.core

Class Category<T extends Pojo>

java.lang.Object

com.redhat.thermostat.storage.core.Category<T>

Type Parameters:

T - The model class used for data mapped to this category.

public class Category<T extends Pojo>
extends Object

A description for data persisted in storage. It describes how model objects are going to be categorized in persistent storage.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	dataClassName
protected List<Key<?>>	indexedKeys
protected Map<String,Key<?>>	keys
protected String	name

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Category()
	Category(String name, Class<T> dataClass, Key<?>... keys) Creates a new Category instance with the specified name.
	Category(String name, Class<T> dataClass, List<Key<?>> keys, List<Key<?>> indexedKeys) Creates a new Category instance with the specified name.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Class<T>	getDataClass()
List<Key<?>>	getIndexedKeys()
Key<?>	getKey(String name)
Collection<Key<?>>	getKeys()
String	getName()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

keys

protected Map<String,Key<?>> keys

indexedKeys

protected List<Key<?>> indexedKeys

dataClassName

protected String dataClassName

Constructor Detail

Category

protected Category()

Category

public Category(String name,
                Class<T> dataClass,
                Key<?>... keys)

Creates a new Category instance with the specified name.

Parameters:

name - the name of the category

dataClass - the Class object representing the data

keys - an array of Key object which represent the data for this category

Throws:

IllegalArgumentException - if a Category is created with a name that has been used before

Category

public Category(String name,
                Class<T> dataClass,
                List<Key<?>> keys,
                List<Key<?>> indexedKeys)

Creates a new Category instance with the specified name.

Parameters:

name - the name of the category

dataClass - the Class object representing the data

indexedKeys - the keys that will be used for sorting and should be indexed (or otherwise optimized) by the storage

keys - an array of Key object which represent the data for this category

Throws:

IllegalArgumentException - if a Category is created with a name that has been used before

Method Detail

getName

public String getName()

Returns:

The category name which uniquely identifies this category.

getDataClass

public Class<T> getDataClass()

getKeys

public Collection<Key<?>> getKeys()

Returns:

A collection of Keys for this category or an empty collection if no keys.

getKey

public Key<?> getKey(String name)

Parameters:

name - The name of the key to retrieve.

Returns:

The key with the specified name or null if there was no such key.

getIndexedKeys

public List<Key<?>> getIndexedKeys()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object