com.ihr.xbrl.dts
Interface Member<T>

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

IdentifierMember, InstantModeMember, MemberDuplicate, MemberQName, NullMember, OpenTableRowKeyMember, PeriodMember, PMember, XMLFragmentMember

public interface Member<T>
extends java.lang.Cloneable

A Member is a Dimension Member as defined in the XDT specification.

The XDT Processor is optimized for validation purposes so the XDT processor does not care about the hierarchy of the domain members and order of the relationships. This Member class does care about that by using a similar exploration of the relationships in the DTS but taking care of the representation aspects.

Author:

Ignacio

Method Summary

void	addDomain(java.util.Collection<Member<?>> members) Adds a domain of members.
Member<T>	clone() Clone constructor
int	compareTo(Member<?> o2)
Dimension<?>	getDimension() Access back to the dimensions this member has belongs to
java.util.Collection<Member<?>>	getDomain() Returns the available sub members of this member.
T	getMember() Access to the member.
boolean	hasDomain() Returns true if the member is a Domain and has sub-members
boolean	isAbstract() This method returns true if the member associated is abstract
boolean	isPrimary() This method returns true if the member is a primary item, otherwise is a dimension member of either an XDT dimension or a Virtual dimension

Method Detail

clone

Member<T> clone()

Clone constructor

Returns:

getMember

T getMember()

Access to the member.

Returns:

element of the class of the Member type

hasDomain

boolean hasDomain()

Returns true if the member is a Domain and has sub-members

Returns:

boolean value

getDomain

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

Returns the available sub members of this member. In the case there were no sub-members the function returns null.

Returns:

Collection of sub members of class T

See Also:

#hasDomain()}

addDomain

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

Adds a domain of members. This method should be called only if the member has no domain. This method should use the clone<T> method for adding copies of the members that are passed as parameter

Parameters:

members -

isAbstract

boolean isAbstract()

This method returns true if the member associated is abstract

Returns:

boolean

isPrimary

boolean isPrimary()

This method returns true if the member is a primary item, otherwise is a dimension member of either an XDT dimension or a Virtual dimension

getDimension

Dimension<?> getDimension()

Access back to the dimensions this member has belongs to

Returns:

compareTo

int compareTo(Member<?> o2)

Parameters:

o2 -

Returns: