com.ihr.xbrl.dts

Class PeriodDimension

java.lang.Object

com.ihr.xbrl.dts.PeriodDimension

All Implemented Interfaces:

Dimension<ColumnPeriod>, java.lang.Comparable<Dimension<?>>

Direct Known Subclasses:

PeriodDimensionDuration, PeriodDimensionInstant

public abstract class PeriodDimension
extends java.lang.Object
implements Dimension<ColumnPeriod>

Make this class abstract and create two non abstract classes, one for instants another for duration.

Author:

Ignacio

Nested Class Summary

Nested classes/interfaces inherited from interface com.ihr.xbrl.dts.Dimension

Dimension.DimensionType

Field Summary

Fields inherited from interface com.ihr.xbrl.dts.Dimension

defaultDimensionsXBRL, duplicatesDimension, entityDimension, formLineDimenion, instantModeDimension, instantOnDurationDimension, periodDimensionCombined, periodDimensionDuration, periodDimensionInstant, POSITION_AVAIL, POSITION_COLUMN_HEADERS, POSITION_ROW_HEADERS, POSITION_UNKNOWN, rowOrColumnLabelDimension, RSDimensionsNameNamespace, RSDimensionsNameNamespacePrefix, unitDimension

Constructor Summary

Constructors

Constructor and Description
PeriodDimension(HasBoySupport hb) Instantiates a new period dimension.

Method Summary

Modifier and Type	Method and Description
boolean	addMember(Member<?> member) Adds the member.
boolean	bHasFixedName() B has fixed name.
void	clear() Empty the Period Dimension content so it can be recreated from the instance.
int	compareTo(Dimension<?> o) Compare to.
boolean	delMember(Member<?> member) Del member.
boolean	factMatches(XDTFactWithVirtualDimensions item, Member<?> mem, java.lang.Object contextualExtraInformation) Fact matches.
boolean	factMatches(XDTFactWithVirtualDimensions item, Member<?> mem, java.util.Set<javax.xml.namespace.QName> dimensionsToMatch, java.lang.Object contextualExtraInformation) Fact matches.
Member<?>	findMember(Member<?> mem) Find member.
Member<?>	getDefault() Gets the default.
XDTDimension	getDimension() Gets the dimension.
java.util.Collection<Member<?>>	getDomain() Gets the domain.
Member<?>	getMemberFromString(java.lang.String value) Gets the member from string.
java.util.Collection<Member<?>>	getMembers() Gets the members.
int	getSuggestedInitialPosition(javax.xml.namespace.QName selectedPrimaryItem) Gets the suggested initial position.
Dimension.DimensionType	getType() Gets the type.
boolean	isOpen() Checks if is open.
boolean	isPrimary() Checks if is primary.
boolean	isTree() Checks if is tree.
boolean	isXDTDimension() Checks if is XDT dimension.
void	setAllowDuplicates(boolean allowDuplicates) Sets the allow duplicates.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ihr.xbrl.dts.Dimension

equals, getDimensionName, getName, hashCode

Constructor Detail

PeriodDimension

public PeriodDimension(HasBoySupport hb)

Instantiates a new period dimension.

Parameters:

hb - the hb

Method Detail

addMember

public boolean addMember(Member<?> member)

Adds the member.

Specified by:

addMember in interface Dimension<ColumnPeriod>

Parameters:

member - the member

Returns:

true, if successful

delMember

public boolean delMember(Member<?> member)

Del member.

Specified by:

delMember in interface Dimension<ColumnPeriod>

Parameters:

member - the member

Returns:

true, if successful

setAllowDuplicates

public void setAllowDuplicates(boolean allowDuplicates)

Sets the allow duplicates.

Specified by:

setAllowDuplicates in interface Dimension<ColumnPeriod>

Parameters:

allowDuplicates - the new allow duplicates

bHasFixedName

public boolean bHasFixedName()

B has fixed name.

Specified by:

bHasFixedName in interface Dimension<ColumnPeriod>

Returns:

true, if successful

getSuggestedInitialPosition

public int getSuggestedInitialPosition(javax.xml.namespace.QName selectedPrimaryItem)

Gets the suggested initial position.

Specified by:

getSuggestedInitialPosition in interface Dimension<ColumnPeriod>

Parameters:

selectedPrimaryItem - the selected primary item

Returns:

the suggested initial position

getMembers

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

Gets the members.

Specified by:

getMembers in interface Dimension<ColumnPeriod>

Returns:

the members

isTree

public boolean isTree()

Checks if is tree.

Specified by:

isTree in interface Dimension<ColumnPeriod>

Returns:

true, if is tree

isXDTDimension

public boolean isXDTDimension()

Checks if is XDT dimension.

Specified by:

isXDTDimension in interface Dimension<ColumnPeriod>

Returns:

true, if is XDT dimension

getDimension

public XDTDimension getDimension()

Gets the dimension.

Specified by:

getDimension in interface Dimension<ColumnPeriod>

Returns:

the dimension

getDomain

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

Gets the domain.

Specified by:

getDomain in interface Dimension<ColumnPeriod>

Returns:

the domain

isPrimary

public boolean isPrimary()

Checks if is primary.

Specified by:

isPrimary in interface Dimension<ColumnPeriod>

Returns:

true, if is primary

factMatches

public boolean factMatches(XDTFactWithVirtualDimensions item,
                           Member<?> mem,
                           java.util.Set<javax.xml.namespace.QName> dimensionsToMatch,
                           java.lang.Object contextualExtraInformation)

Fact matches.

Specified by:

factMatches in interface Dimension<ColumnPeriod>

Parameters:

item - the item

mem - the mem

dimensionsToMatch - the dimensions to match

contextualExtraInformation - the contextual extra information

Returns:

true, if successful

factMatches

public boolean factMatches(XDTFactWithVirtualDimensions item,
                           Member<?> mem,
                           java.lang.Object contextualExtraInformation)

Fact matches.

Specified by:

factMatches in interface Dimension<ColumnPeriod>

Parameters:

item - the item

mem - the mem

contextualExtraInformation - the contextual extra information

Returns:

true, if successful

getDefault

public Member<?> getDefault()

Gets the default.

Specified by:

getDefault in interface Dimension<ColumnPeriod>

Returns:

the default

clear

public void clear()

Empty the Period Dimension content so it can be recreated from the instance.

findMember

public Member<?> findMember(Member<?> mem)

Find member.

Specified by:

findMember in interface Dimension<ColumnPeriod>

Parameters:

mem - the mem

Returns:

the member

getType

public Dimension.DimensionType getType()

Gets the type.

Specified by:

getType in interface Dimension<ColumnPeriod>

Returns:

the type

compareTo

public int compareTo(Dimension<?> o)

Compare to.

Specified by:

compareTo in interface java.lang.Comparable<Dimension<?>>

Parameters:

o - the o

Returns:

the int

getMemberFromString

public Member<?> getMemberFromString(java.lang.String value)

Gets the member from string.

Specified by:

getMemberFromString in interface Dimension<ColumnPeriod>

Parameters:

value - the value

Returns:

the member from string

isOpen

public boolean isOpen()

Checks if is open.

Specified by:

isOpen in interface Dimension<ColumnPeriod>

Returns:

true, if is open