com.ihr.xbrl.dts

Class XMLFragmentMember

java.lang.Object

com.ihr.xbrl.dts.XMLFragmentMember

All Implemented Interfaces:

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

public class XMLFragmentMember
extends java.lang.Object
implements Member<XMLFragment>

Implements the Member interface for typed dimension members.

Author:

Ignacio

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XMLFragmentMember(XMLFragment fragment, Dimension<?> dim, java.lang.String text) Instantiates a new XML fragment member.

Method Summary

Modifier and Type	Method and Description
void	addDomain(java.util.Collection<Member<?>> members) Adds the domain.
XMLFragmentMember	clone() Clone.
int	compareTo(Member<?> o2) Compare to.
boolean	equals(java.lang.Object obj) Equals.
Dimension<?>	getDimension() Gets the dimension.
java.util.Collection<Member<?>>	getDomain() Gets the domain.
XMLFragment	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.
Dimension<?>	setDimension(Dimension<?> newDimension) Sets the dimension.
void	setHidden() Sets the hidden.
void	setText(java.lang.String newText) Sets the text.
void	setVisible() Sets the visible.
void	setVisible(boolean value) Sets the visible.
XMLFragment	toFragment(DTSContainer dts) To fragment.
java.lang.String	toString() To string.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XMLFragmentMember

public XMLFragmentMember(XMLFragment fragment,
                         Dimension<?> dim,
                         java.lang.String text)

Instantiates a new XML fragment member.

Parameters:

fragment - the fragment

dim - the dim

text - the text or null if the text is going to be created internally

Method Detail

clone

public XMLFragmentMember clone()

Clone.

Specified by:

clone in interface Member<XMLFragment>

Overrides:

clone in class java.lang.Object

Returns:

the XML fragment member

addDomain

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

Adds the domain.

Specified by:

addDomain in interface Member<XMLFragment>

Parameters:

members - the members

compareTo

public int compareTo(Member<?> o2)

Compare to.

Specified by:

compareTo in interface Member<XMLFragment>

Parameters:

o2 - the o 2

Returns:

the int

getDimension

public Dimension<?> getDimension()

Gets the dimension.

Specified by:

getDimension in interface Member<XMLFragment>

Returns:

the dimension

setDimension

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

Sets the dimension.

Specified by:

setDimension in interface Member<XMLFragment>

Parameters:

newDimension - the new dimension

Returns:

the dimension

getDomain

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

Gets the domain.

Specified by:

getDomain in interface Member<XMLFragment>

Returns:

the domain

See Also:

Member.hasDomain()

getMember

public XMLFragment getMember()

Gets the member.

Specified by:

getMember in interface Member<XMLFragment>

Returns:

the member

hasDomain

public boolean hasDomain()

Checks for domain.

Specified by:

hasDomain in interface Member<XMLFragment>

Returns:

true, if successful

isAbstract

public boolean isAbstract()

Checks if is abstract.

Specified by:

isAbstract in interface Member<XMLFragment>

Returns:

true, if is abstract

isPrimary

public boolean isPrimary()

Checks if is primary.

Specified by:

isPrimary in interface Member<XMLFragment>

Returns:

true, if is primary

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<XMLFragment>

Returns:

boolean value

isVisible

public boolean isVisible()

Checks if is visible.

Specified by:

isVisible in interface Member<XMLFragment>

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<XMLFragment>

Parameters:

value - the new visible

setHidden

public void setHidden()

Sets the hidden.

toFragment

public XMLFragment toFragment(DTSContainer dts)

To fragment.

Parameters:

dts - the dts

Returns:

the XML fragment

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

setText

public void setText(java.lang.String newText)

Sets the text.

Parameters:

newText - the new text

toString

public java.lang.String toString()

To string.

Specified by:

toString in interface Member<XMLFragment>

Overrides:

toString in class java.lang.Object

Returns:

the string

isTotal

public boolean isTotal()

Checks if is total.

Specified by:

isTotal in interface Member<XMLFragment>

Returns:

true, if is total

isNet

public boolean isNet()

Checks if is net.

Specified by:

isNet in interface Member<XMLFragment>

Returns:

true, if is net

isNegated

public boolean isNegated()

Checks if is negated.

Specified by:

isNegated in interface Member<XMLFragment>

Returns:

true, if is negated