com.cinchapi.concourse.util

Class PrettyLinkedTableMap<R,C,V>

Object

AbstractMap<K,V>

HashMap<K,V>

LinkedHashMap<R,Map<C,V>>

PrettyLinkedTableMap<R,C,V>

All Implemented Interfaces:

PrettyTableMap<R,C,V>, TableMap<R,C,V>, Serializable, Cloneable, Map<R,Map<C,V>>

public class PrettyLinkedTableMap<R,C,V>
extends LinkedHashMap<R,Map<C,V>>
implements PrettyTableMap<R,C,V>

A special LinkedHashMap that simulates a sparse table where a row key maps to a set of columns and each column maps to a value (e.g. Map[R, -> Map[C -> V]]). This object has pretty toString() output that is formatted as such:

 +-----------------------------------------------------------+
 | Record           | name          | gender      | joinedBy |
 +-----------------------------------------------------------+
 | 1416242356271000 | Deary Hudson  | UNSPECIFIED | EMAIL    |
 | 1416242356407000 | Jeff Nelson   | UNSPECIFIED | EMAIL    |
 | 1416242356436000 | Morgan Debaun | UNSPECIFIED | EMAIL    |
 +-----------------------------------------------------------+
 

A PrettyLinkedTableMap is suitable for displaying information about multiple records or documents.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
static <R,C,V> PrettyTableMap<R,C,V>	create() Return an empty Map with "pretty" string representation, using the default identifier name.
static <R,C,V> PrettyTableMap<R,C,V>	create(String identifierColumnHeader) Return an empty Map with "pretty" string representation.
static <R,C,V> PrettyLinkedTableMap<R,C,V>	newPrettyLinkedTableMap() Deprecated. use create() instead
static <R,C,V> PrettyLinkedTableMap<R,C,V>	newPrettyLinkedTableMap(String identifierColumnHeader) Deprecated. use create(String) instead
static <R,C,V> PrettyTableMap<R,C,V>	of(Map<R,Map<C,V>> data) Return a new Map containing all the entries from data that "prettifies" its string representation on-demand.
static <R,C,V> PrettyTableMap<R,C,V>	of(Map<R,Map<C,V>> data, String identifierColumnHeader) Return a new Map containing all the entries from data that "prettifies" its string representation on-demand.
V	put(R row, C column, V value) Insert value under column in row.
Map<C,V>	put(R key, Map<C,V> value) THIS METHOD ALWAYS RETURNS null.
void	putAll(Map<? extends R,? extends Map<C,V>> m)
PrettyLinkedTableMap<R,C,V>	setIdentifierColumnHeader(String header) Set the identifierColumnHeader to header.
PrettyLinkedTableMap<R,C,V>	setRowName(String name) Deprecated. use setIdentifierColumnHeader(String) instead
String	toString()

Methods inherited from class LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class AbstractMap

equals, hashCode

Methods inherited from class Object

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

Methods inherited from interface Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

create

public static <R,C,V> PrettyTableMap<R,C,V> create()

Return an empty Map with "pretty" string representation, using the default identifier name.

Returns:

the new Map

create

public static <R,C,V> PrettyTableMap<R,C,V> create(String identifierColumnHeader)

Return an empty Map with "pretty" string representation.

identifierColumnHeader is used as the header for the column that contains the the identifier for each row in the "table".

Parameters:

identifierColumnHeader -

Returns:

the new Map

newPrettyLinkedTableMap

@Deprecated
public static <R,C,V> PrettyLinkedTableMap<R,C,V> newPrettyLinkedTableMap()

Deprecated. use create() instead

Return an empty PrettyLinkedTableMap with the default row name.

Returns:

the PrettyLinkedTableMap

newPrettyLinkedTableMap

@Deprecated
public static <R,C,V> PrettyLinkedTableMap<R,C,V> newPrettyLinkedTableMap(String identifierColumnHeader)

Deprecated. use create(String) instead

Return an empty PrettyLinkedTableMap with the specified identifierColumnHeader.

Parameters:

identifierColumnHeader -

Returns:

the PrettyLinkedTableMap

of

public static <R,C,V> PrettyTableMap<R,C,V> of(Map<R,Map<C,V>> data)

Return a new Map containing all the entries from data that "prettifies" its string representation on-demand.

The returned Map copies, but does not "read through" to data. It is mutable, but changes made to it are not reflected in data and vice versa.

Parameters:

data -

Returns:

a Map containing data that has pretty toString() output

of

public static <R,C,V> PrettyTableMap<R,C,V> of(Map<R,Map<C,V>> data,
                                               String identifierColumnHeader)

Return a new Map containing all the entries from data that "prettifies" its string representation on-demand.

The returned Map copies, but does not "read through" to data. It is mutable, but changes made to it are not reflected in data and vice versa.

identifierColumnHeader is used as the header for the column that contains the the identifier for each row in the "table".

Parameters:

data -

identifierColumnHeader -

Returns:

a Map containing data that has pretty toString() output

put

public V put(R row,
             C column,
             V value)

Description copied from interface: TableMap

Insert value under column in row.

Specified by:

put in interface TableMap<R,C,V>

Returns:

the previous value located at the intersection of row and column or null if one did not previously exist.

put

public Map<C,V> put(R key,
                    Map<C,V> value)

THIS METHOD ALWAYS RETURNS null.

Specified by:

put in interface Map<R,Map<C,V>>

Overrides:

put in class HashMap<R,Map<C,V>>

putAll

public void putAll(Map<? extends R,? extends Map<C,V>> m)

Specified by:

putAll in interface Map<R,Map<C,V>>

Overrides:

putAll in class HashMap<R,Map<C,V>>

setIdentifierColumnHeader

public PrettyLinkedTableMap<R,C,V> setIdentifierColumnHeader(String header)

Description copied from interface: PrettyTableMap

Set the identifierColumnHeader to header.

Specified by:

setIdentifierColumnHeader in interface PrettyTableMap<R,C,V>

Returns:

this

setRowName

@Deprecated
public PrettyLinkedTableMap<R,C,V> setRowName(String name)

Deprecated. use setIdentifierColumnHeader(String) instead

Set the identifierColumnHeader to name.

Parameters:

name -

Returns:

this

toString

public String toString()

Overrides:

toString in class AbstractMap<R,Map<C,V>>