com.ihr.xbrl.om.table.layout

Class Header

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<java.lang.Object,java.util.LinkedHashSet<java.lang.Object>>

com.ihr.xbrl.om.table.layout.Header

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.util.LinkedHashSet<java.lang.Object>>

public class Header
extends java.util.LinkedHashMap<java.lang.Object,java.util.LinkedHashSet<java.lang.Object>>

A Header is a data structure that contains all cell aspects by axis So, for a single cell it is possible to obtain all dimensions in the X, Y or Z axis.

Note:
The Z axis applies to all cells in a table
The X axis applies to all columns in the same row
The Y axis applies to all rows in the same column

For this reason, a table contains 3 instances of Header. One for each axis The header is a LinkedHashMap, keys in the LinkedHashMap are aspect identity keys. value for each key is a Set of distinct values.

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

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

Constructor Summary

Constructors

Constructor and Description
Header(Axis axis) Instantiates a new header.
Header(Header zHeader) Instantiates a new header.

Method Summary

Modifier and Type	Method and Description
Axis	getAxis() Gets the axis.

Methods inherited from class java.util.LinkedHashMap

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

Methods inherited from class java.util.HashMap

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

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Constructor Detail

Header

public Header(Axis axis)

Instantiates a new header.

Parameters:

axis - the axis

Header

public Header(Header zHeader)

Instantiates a new header.

Parameters:

zHeader - the z header

Method Detail

getAxis

public Axis getAxis()

Gets the axis.

Returns:

the axis