com.ihr.xbrl.dts

Class NullMember

java.lang.Object

com.ihr.xbrl.dts.NullMember

All Implemented Interfaces:

Member<java.lang.Object>, java.io.Serializable, java.lang.Cloneable

public class NullMember
extends java.lang.Object
implements Member<java.lang.Object>

This is the member that is returned when a primary item may contain a dimension but does not actually contains it in the context. The dimension is stored in the NullMember, but the dimension value is null.

Author:

Ignacio

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NullMember(Dimension<?> dim) Instantiates a new null member.

Method Summary

Modifier and Type	Method and Description
void	addDomain(java.util.Collection<Member<?>> members) Adds the domain.
NullMember	clone() Clone.
int	compareTo(Member<?> o2) Compare to.
Dimension<?>	getDimension() Gets the dimension.
java.util.Collection<Member<?>>	getDomain() Gets the domain.
java.lang.Object	getMember() Gets the member.
boolean	hasDomain() Checks for domain.
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.
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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NullMember

public NullMember(Dimension<?> dim)

Instantiates a new null member.

Parameters:

dim - the dim

Method Detail

clone

public NullMember clone()

Clone.

Specified by:

clone in interface Member<java.lang.Object>

Overrides:

clone in class java.lang.Object

Returns:

the null member

addDomain

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

Adds the domain.

Specified by:

addDomain in interface Member<java.lang.Object>

Parameters:

members - the members

compareTo

public int compareTo(Member<?> o2)

Compare to.

Specified by:

compareTo in interface Member<java.lang.Object>

Parameters:

o2 - the o 2

Returns:

the int

getDimension

public Dimension<?> getDimension()

Gets the dimension.

Specified by:

getDimension in interface Member<java.lang.Object>

Returns:

the dimension

getDomain

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

Gets the domain.

Specified by:

getDomain in interface Member<java.lang.Object>

Returns:

the domain

See Also:

Member.hasDomain()

getMember

public java.lang.Object getMember()

Gets the member.

Specified by:

getMember in interface Member<java.lang.Object>

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.Object>

Returns:

boolean value

hasDomain

public boolean hasDomain()

Checks for domain.

Specified by:

hasDomain in interface Member<java.lang.Object>

Returns:

true, if successful

isAbstract

public boolean isAbstract()

Checks if is abstract.

Specified by:

isAbstract in interface Member<java.lang.Object>

Returns:

true, if is abstract

isPrimary

public boolean isPrimary()

Checks if is primary.

Specified by:

isPrimary in interface Member<java.lang.Object>

Returns:

true, if is primary

isVisible

public boolean isVisible()

Checks if is visible.

Specified by:

isVisible in interface Member<java.lang.Object>

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.Object>

Parameters:

value - the new visible

setHidden

public void setHidden()

Sets the hidden.

toString

public java.lang.String toString()

To string.

Specified by:

toString in interface Member<java.lang.Object>

Overrides:

toString in class java.lang.Object

Returns:

the string

setDimension

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

Sets the dimension.

Specified by:

setDimension in interface Member<java.lang.Object>

Parameters:

newDimension - the new dimension

Returns:

the dimension

isTotal

public boolean isTotal()

Checks if is total.

Specified by:

isTotal in interface Member<java.lang.Object>

Returns:

true, if is total

isNet

public boolean isNet()

Checks if is net.

Specified by:

isNet in interface Member<java.lang.Object>

Returns:

true, if is net

isNegated

public boolean isNegated()

Checks if is negated.

Specified by:

isNegated in interface Member<java.lang.Object>

Returns:

true, if is negated