com.ihr.xbrl.dts

Interface KeysForFactsProvider

public interface KeysForFactsProvider

The Interface KeysForFactsProvider.

Author:

Ignacio

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	KeysForFactsProvider.Referenciable Mark interface .
static class	KeysForFactsProvider.ReferenciableContext The Class ReferenciableContext.
static class	KeysForFactsProvider.ReferenciableElement The Class ReferenciableElement.
static class	KeysForFactsProvider.ReferenciableFact This class provides information to allow the GUI to find a fact if the user clicks on it.
static class	KeysForFactsProvider.ReferenciableFixReplaceValue Helper class to store information to fix a calculation inconsistency by replacing the total with the proposed value.
static class	KeysForFactsProvider.ReferenciableResource The Class ReferenciableResource.
static class	KeysForFactsProvider.ReferenciableUnit The Class ReferenciableUnit.

Method Summary

Modifier and Type	Method and Description
java.lang.String	addContextRef(KeysForFactsProvider.ReferenciableContext contextRef) Adds a context reference.
java.lang.String	addElementRef(KeysForFactsProvider.ReferenciableElement elementRef) Adds the element reference.
java.lang.String	addFactRef(KeysForFactsProvider.ReferenciableFact factRef) Adds the fact reference.
java.lang.String	addResourceRef(KeysForFactsProvider.ReferenciableResource resourceRef) Adds the resource reference.
java.lang.String	addToggleBranchRef(Branch branch, java.lang.Object anchor) Creates a code for a branch that is like a mark the user can click on and fires a message to expand the message content.
java.lang.String	addUnitRef(KeysForFactsProvider.ReferenciableUnit unitRef) Adds a unit reference.

Method Detail

addFactRef

java.lang.String addFactRef(KeysForFactsProvider.ReferenciableFact factRef)

Adds the fact reference.

Parameters:

factRef - the fact reference so the GUI can find it at later time

Returns:

the string representation of the link

See Also:

ReferenciableFact class declaration

addToggleBranchRef

java.lang.String addToggleBranchRef(Branch branch,
                                    java.lang.Object anchor)

Creates a code for a branch that is like a mark the user can click on and fires a message to expand the message content.

Parameters:

branch - the branch

anchor - the object used to identify the owner of this branch, a fact or an assertion message. Must implement hashCode and equals

Returns:

code to identify the branch

addElementRef

java.lang.String addElementRef(KeysForFactsProvider.ReferenciableElement elementRef)

Adds the element reference.

Parameters:

elementRef - the element (concept, item or tuple definition) reference so the GUI can find it at later time

Returns:

the string representation of the link

See Also:

ReferenciableElement class declaration

addResourceRef

java.lang.String addResourceRef(KeysForFactsProvider.ReferenciableResource resourceRef)

Adds the resource reference.

Parameters:

resourceRef - the resource reference so the GUI can find it at later time

Returns:

the string representation of the link

See Also:

ReferenciableResource class declaration

addContextRef

java.lang.String addContextRef(KeysForFactsProvider.ReferenciableContext contextRef)

Adds a context reference.

Parameters:

contextRef - the context reference so the GUI can find it at later time

Returns:

the string representation of the link

See Also:

ReferenciableContext class declaration

addUnitRef

java.lang.String addUnitRef(KeysForFactsProvider.ReferenciableUnit unitRef)

Adds a unit reference.

Parameters:

unitRef - the context reference so the GUI can find it at later time

Returns:

the string representation of the link

See Also:

ReferenciableUnit class declaration