com.ihr.xbrl.dts

Class OpenTableRowKeyMember

java.lang.Object

com.ihr.xbrl.dts.OpenTableRowKeyMember

All Implemented Interfaces:

Member<java.lang.Integer>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<OpenTableRowKeyMember>

public class OpenTableRowKeyMember
extends java.lang.Object
implements Member<java.lang.Integer>, java.lang.Comparable<OpenTableRowKeyMember>

The Class OpenTableRowKeyMember.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	dimensionUserName The Constant dimensionUserName.
static javax.xml.namespace.QName	openTableDimensionQName The Constant openTableDimensionQName.

Constructor Summary

Constructors

Constructor and Description
OpenTableRowKeyMember(java.util.Map<javax.xml.namespace.QName,java.lang.Object> dimAndValueTable) Instantiates a new open table row key member.

Method Summary

Modifier and Type	Method and Description
void	addDomain(java.util.Collection<Member<?>> members) Adds the domain.
OpenTableRowKeyMember	clone() Clone.
int	compareTo(Member<?> o2) Compare to.
int	compareTo(OpenTableRowKeyMember o) Compare to.
boolean	equals(java.lang.Object obj) Equals.
Dimension<?>	getDimension() Gets the dimension.
java.util.Collection<Member<?>>	getDomain() Gets the domain.
java.util.Map<javax.xml.namespace.QName,java.lang.Object>	getExtraDimensions() Gets the extra dimensions.
java.util.Map<javax.xml.namespace.QName,java.lang.Object>	getHashTable() Gets the hash table.
java.lang.Integer	getMember() Gets the member.
boolean	hasDomain() Checks for domain.
int	hashCode() Hash code.
boolean	isAbstract() Checks if is abstract.
boolean	isNegated() Checks if is negated.
boolean	isNet() Checks if is net.
boolean	isPrimary() Checks if is primary.
boolean	isTotal() Checks if is total.
boolean	isUsable() When the member is part of a dimensional domain, this method returns true if the target member is usable or false if it is not
boolean	isVisible() Checks if is visible.
static void	resetCounter() Reset counter.
Dimension<?>	setDimension(Dimension<?> newDimension) Sets the dimension.
void	setHidden() Sets the hidden.
void	setVisible() Sets the visible.
void	setVisible(boolean value) Sets the visible.
java.lang.String	toString() To string.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

openTableDimensionQName

public static final javax.xml.namespace.QName openTableDimensionQName

The Constant openTableDimensionQName.

dimensionUserName

public static final java.lang.String dimensionUserName

The Constant dimensionUserName.

See Also:

Constant Field Values

Constructor Detail

OpenTableRowKeyMember

public OpenTableRowKeyMember(java.util.Map<javax.xml.namespace.QName,java.lang.Object> dimAndValueTable)

Instantiates a new open table row key member.

Parameters:

dimAndValueTable - the dim and value table

Method Detail

resetCounter

public static void resetCounter()

Reset counter.

clone

public OpenTableRowKeyMember clone()

Clone.

Specified by:

clone in interface Member<java.lang.Integer>

Overrides:

clone in class java.lang.Object

Returns:

the open table row key member

getHashTable

public java.util.Map<javax.xml.namespace.QName,java.lang.Object> getHashTable()

Gets the hash table.

Returns:

the hash table

getExtraDimensions

public java.util.Map<javax.xml.namespace.QName,java.lang.Object> getExtraDimensions()

Gets the extra dimensions.

Returns:

the extra dimensions

getMember

public java.lang.Integer getMember()

Gets the member.

Specified by:

getMember in interface Member<java.lang.Integer>

Returns:

the member

isUsable

public boolean isUsable()

Description copied from interface: Member

When the member is part of a dimensional domain, this method returns true if the target member is usable or false if it is not

Specified by:

isUsable in interface Member<java.lang.Integer>

Returns:

boolean value

hasDomain

public boolean hasDomain()

Checks for domain.

Specified by:

hasDomain in interface Member<java.lang.Integer>

Returns:

true, if successful

getDomain

public java.util.Collection<Member<?>> getDomain()

Gets the domain.

Specified by:

getDomain in interface Member<java.lang.Integer>

Returns:

the domain

See Also:

Member.hasDomain()

addDomain

public void addDomain(java.util.Collection<Member<?>> members)

Adds the domain.

Specified by:

addDomain in interface Member<java.lang.Integer>

Parameters:

members - the members

isAbstract

public boolean isAbstract()

Checks if is abstract.

Specified by:

isAbstract in interface Member<java.lang.Integer>

Returns:

true, if is abstract

isPrimary

public boolean isPrimary()

Checks if is primary.

Specified by:

isPrimary in interface Member<java.lang.Integer>

Returns:

true, if is primary

isVisible

public boolean isVisible()

Checks if is visible.

Specified by:

isVisible in interface Member<java.lang.Integer>

Returns:

true, if is visible

setVisible

public void setVisible()

Sets the visible.

setVisible

public void setVisible(boolean value)

Sets the visible.

Specified by:

setVisible in interface Member<java.lang.Integer>

Parameters:

value - the new visible

setHidden

public void setHidden()

Sets the hidden.

getDimension

public Dimension<?> getDimension()

Gets the dimension.

Specified by:

getDimension in interface Member<java.lang.Integer>

Returns:

the dimension

setDimension

public Dimension<?> setDimension(Dimension<?> newDimension)

Sets the dimension.

Specified by:

setDimension in interface Member<java.lang.Integer>

Parameters:

newDimension - the new dimension

Returns:

the dimension

compareTo

public int compareTo(Member<?> o2)

Compare to.

Specified by:

compareTo in interface Member<java.lang.Integer>

Parameters:

o2 - the o 2

Returns:

the int

hashCode

public int hashCode()

Hash code.

Overrides:

hashCode in class java.lang.Object

Returns:

the int

equals

public boolean equals(java.lang.Object obj)

Equals.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the obj

Returns:

true, if successful

toString

public java.lang.String toString()

To string.

Specified by:

toString in interface Member<java.lang.Integer>

Overrides:

toString in class java.lang.Object

Returns:

the string

compareTo

public int compareTo(OpenTableRowKeyMember o)

Compare to.

Specified by:

compareTo in interface java.lang.Comparable<OpenTableRowKeyMember>

Parameters:

o - the o

Returns:

the int

isTotal

public boolean isTotal()

Checks if is total.

Specified by:

isTotal in interface Member<java.lang.Integer>

Returns:

true, if is total

isNet

public boolean isNet()

Checks if is net.

Specified by:

isNet in interface Member<java.lang.Integer>

Returns:

true, if is net

isNegated

public boolean isNegated()

Checks if is negated.

Specified by:

isNegated in interface Member<java.lang.Integer>

Returns:

true, if is negated