com.ihr.xbrl.om

Class XBRLEvent

java.lang.Object

com.ihr.xbrl.om.XBRLEvent

public abstract class XBRLEvent
extends java.lang.Object

Base class for all XBRL Events.

Events are generated to allow consuming applications to register to them via the DTSContainer.addPropertyChangeListener(String, java.beans.PropertyChangeListener) mechanism

Since:

3.1.0

Author:

Ignacio

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARCROLETYPE_ADD Generated when a new arc role type is added to the DTSContainer.
static java.lang.String	ARCROLETYPE_DEL Generated when an arc role type is no longer used and removed from DTSContainer.
static java.lang.String	ARCROLETYPE_MODIFIED Generated when a property of an arc role type is modified.
static java.lang.String	ARCROLETYPE_VALIDATE_ARCROLEREF For internal use: this event is added to validate a arcroleRef and arcrole resolves to the referenced arcrole.
static java.lang.String	CONCEPT_ADD Generated when a concept has been added to a DTSContainer.
static java.lang.String	CONCEPT_DEL Generated when a concept has been removed from a DTSContainer.
static java.lang.String	CONCEPT_END Generated at the end of a set of bulk concept related events.
static java.lang.String	CONCEPT_MODIFIED Generated when a concept has been removed from a DTSContainer.
static java.lang.String	CONCEPT_START Generated when a bulk set of concept related events will follow.
static java.lang.String	DTS_CREATED This is a global event.
static java.lang.String	DTS_LINKBASE_ADDED This event is fired when a new linkbase file is added to the DTSContainer.
static java.lang.String	DTS_SCHEMA_ADDED This event is fired when a new schema file is added to the DTSContainer.
static java.lang.String	FACT_ADD Generated when a fact has been added to an XBRLInstance or XBRLTuple.
static java.lang.String	FACT_ATTR_MODIFIED Generated when an attribute value has been modified on a fact.
static java.lang.String	FACT_DEL Generated when a fact has been removed from an XBRLInstance or XBRLTuple.
static java.lang.String	FACT_END Generated at the end of a set of bulk fact related events.
static java.lang.String	FACT_MODIFIED Generated when a fact has been removed from an XBRLInstance or XBRLTuple or when an important fact property changes.
static java.lang.String	FACT_START Generated when a bulk set of fact related events will follow.
static java.lang.String	INSTANCE_ADD Generated when a new XBRL report is created.
static java.lang.String	IXBRL_END Generated when the DTSContainer ends converting an ixbrl to a xbrl.
static java.lang.String	IXBRL_START Generated when the DTSContainer begins to convert an ixbrl to a xbrl.
static java.lang.String	PROCESSOR_INTERRUPTED This event is fired when the DTSContainer process is interrupted and the processor has finished processing the interruption.
static java.lang.String	RELATIONSHIP_ADD Generated when a relationship has been added to a DTSContainer.
static java.lang.String	RELATIONSHIP_DEL Generated when a relationship has been removed from a DTSContainer.
static java.lang.String	RELATIONSHIP_END Generated at the end of a set of bulk relationship related events.
static java.lang.String	RELATIONSHIP_MODIFIED Generated when a relationship has been removed from a DTSContainer.
static java.lang.String	RELATIONSHIP_START Generated when a bulk set of relationship related events will follow.
static java.lang.String	RESOURCE_ADD Generated when a resource has been added to a DTSContainer.
static java.lang.String	RESOURCE_DEL Generated when a resource has been removed from a DTSContainer.
static java.lang.String	RESOURCE_END Generated at the end of a set of bulk resource related events.
static java.lang.String	RESOURCE_MODIFIED Generated when a resource has been removed from a DTSContainer.
static java.lang.String	RESOURCE_START Generated when a bulk set of resource related events will follow.
static java.lang.String	ROLETYPE_ADD Generated when a new role type is added to the DTSContainer.
static java.lang.String	ROLETYPE_DEL Generated when a role type is no longer used and removed from DTSContainer.
static java.lang.String	ROLETYPE_MODIFIED Generated when a property of a role type is modified.
static java.lang.String	ROLETYPE_VALIDATE_ROLEREF For internal use: this event is added to validate a roleRef and role resolves to the referenced role.
static java.lang.String	STATUS_CHANGED This event is fired every time the processor status changes value Processor status values are documented in the DTSContainer.Status enumeration the old and new values on the event are the old and new status values
static java.lang.String	UNDER_EVALUATION_INSTANCE Generated when the instance document under evaluation is changed in the DTSContainer.

Constructor Summary

Constructors

Constructor and Description
XBRLEvent()

Method Summary

Modifier and Type	Method and Description
static boolean	isFactContextEvent(java.beans.PropertyChangeEvent ppch) Explores the PropertyChangeEvent received and returns true if the event is related with a change in the fact context.
static boolean	isFactUnitEvent(java.beans.PropertyChangeEvent ppch) Explores the PropertyChangeEvent received and returns true if the event is related with a change in the fact unit.

Methods inherited from class java.lang.Object

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

Field Detail

DTS_CREATED

public static final java.lang.String DTS_CREATED

This is a global event. Applications can subscribe to this event using the DTSContainer returned by DTSContainer.getStaticContainer().DTSContainer.addPropertyChangeListener(String, java.beans.PropertyChangeListener) and will be notified about the creation of a new DTSContainer instance

See Also:

Constant Field Values

DTS_SCHEMA_ADDED

public static final java.lang.String DTS_SCHEMA_ADDED

This event is fired when a new schema file is added to the DTSContainer. This event allows processors to be informed about the files being added to the DTSContainer and react in case the file is not part of the allowed URLs for the project. For example, the US-GAAP processor uses this method to self disable it when it is activated and one URL not allowed is found. This allows the processor to reduce the number of errors generated.

The oldValue contains null
The newValue contains the new XBRLTaxonomy being added

See Also:

Constant Field Values

DTS_LINKBASE_ADDED

public static final java.lang.String DTS_LINKBASE_ADDED

This event is fired when a new linkbase file is added to the DTSContainer. This event allows processors to be informed about the files being added to the DTSContainer and react in case the file is not part of the allowed URLs for the project. For example, the US-GAAP processor uses this method to self disable it when it is activated and one URL not allowed is found. This allows the processor to reduce the number of errors generated

The oldValue contains null
The newValue contains the new XBRLLinkbase being added

See Also:

Constant Field Values

PROCESSOR_INTERRUPTED

public static final java.lang.String PROCESSOR_INTERRUPTED

This event is fired when the DTSContainer process is interrupted and the processor has finished processing the interruption. A button in the GUI could use this signal to change disabled status to enabled status again

See Also:

Constant Field Values

STATUS_CHANGED

public static final java.lang.String STATUS_CHANGED

This event is fired every time the processor status changes value Processor status values are documented in the DTSContainer.Status enumeration the old and new values on the event are the old and new status values

See Also:

Constant Field Values

FACT_START

public static final java.lang.String FACT_START

Generated when a bulk set of fact related events will follow.

See Also:

Constant Field Values

FACT_END

public static final java.lang.String FACT_END

Generated at the end of a set of bulk fact related events.

See Also:

Constant Field Values

FACT_ADD

public static final java.lang.String FACT_ADD

Generated when a fact has been added to an XBRLInstance or XBRLTuple.

See Also:

Constant Field Values

FACT_DEL

public static final java.lang.String FACT_DEL

Generated when a fact has been removed from an XBRLInstance or XBRLTuple.

See Also:

Constant Field Values

FACT_MODIFIED

public static final java.lang.String FACT_MODIFIED

Generated when a fact has been removed from an XBRLInstance or XBRLTuple or when an important fact property changes. oldValue is always the XBRLFact generating the event and newValue is an array of two values of which one of them might be null.

The following table shows the event meaning based on the newValue type

The context changed
position 0	position 1	event meaning
null	not null	context assigned to a fact
not null	null	context removed from fact
not null	not null	fact context changed
null	null	This condition is not used

The unit changed
position 0	position 1	event meaning
null	not null	unit assigned to a fact
not null	null	unit removed from fact
not null	not null	fact unit changed
null	null	This condition is not used

fact value changed
position 0	position 1	event meaning
null	not null	fact value changed
not null	null	fact is nil or blank
not null	not null	fact value changed
null	null	fact is nill or blank

See Also:

Constant Field Values

FACT_ATTR_MODIFIED

public static final java.lang.String FACT_ATTR_MODIFIED

Generated when an attribute value has been modified on a fact. Adding or removing an attribute also generates the same event. oldValue contains the fact, newValue contains the attribute Qname

See Also:

Constant Field Values

CONCEPT_START

public static final java.lang.String CONCEPT_START

Generated when a bulk set of concept related events will follow.

See Also:

Constant Field Values

CONCEPT_END

public static final java.lang.String CONCEPT_END

Generated at the end of a set of bulk concept related events.

See Also:

Constant Field Values

CONCEPT_ADD

public static final java.lang.String CONCEPT_ADD

Generated when a concept has been added to a DTSContainer. newValue contains an instance of XMLElementDefinition oldValue might be null or an instance of XBRLItem

See Also:

Constant Field Values

CONCEPT_DEL

public static final java.lang.String CONCEPT_DEL

Generated when a concept has been removed from a DTSContainer.

See Also:

Constant Field Values

CONCEPT_MODIFIED

public static final java.lang.String CONCEPT_MODIFIED

Generated when a concept has been removed from a DTSContainer.

See Also:

Constant Field Values

RESOURCE_START

public static final java.lang.String RESOURCE_START

Generated when a bulk set of resource related events will follow.

See Also:

Constant Field Values

RESOURCE_END

public static final java.lang.String RESOURCE_END

Generated at the end of a set of bulk resource related events.

See Also:

Constant Field Values

RESOURCE_ADD

public static final java.lang.String RESOURCE_ADD

Generated when a resource has been added to a DTSContainer.

See Also:

Constant Field Values

RESOURCE_DEL

public static final java.lang.String RESOURCE_DEL

Generated when a resource has been removed from a DTSContainer.

See Also:

Constant Field Values

RESOURCE_MODIFIED

public static final java.lang.String RESOURCE_MODIFIED

Generated when a resource has been removed from a DTSContainer.

See Also:

Constant Field Values

RELATIONSHIP_START

public static final java.lang.String RELATIONSHIP_START

Generated when a bulk set of relationship related events will follow.

See Also:

Constant Field Values

RELATIONSHIP_END

public static final java.lang.String RELATIONSHIP_END

Generated at the end of a set of bulk relationship related events.

See Also:

Constant Field Values

RELATIONSHIP_ADD

public static final java.lang.String RELATIONSHIP_ADD

Generated when a relationship has been added to a DTSContainer.

See Also:

Constant Field Values

RELATIONSHIP_DEL

public static final java.lang.String RELATIONSHIP_DEL

Generated when a relationship has been removed from a DTSContainer.

See Also:

Constant Field Values

RELATIONSHIP_MODIFIED

public static final java.lang.String RELATIONSHIP_MODIFIED

Generated when a relationship has been removed from a DTSContainer.

See Also:

Constant Field Values

ROLETYPE_ADD

public static final java.lang.String ROLETYPE_ADD

Generated when a new role type is added to the DTSContainer.

See Also:

Constant Field Values

ROLETYPE_DEL

public static final java.lang.String ROLETYPE_DEL

Generated when a role type is no longer used and removed from DTSContainer.

See Also:

Constant Field Values

ROLETYPE_MODIFIED

public static final java.lang.String ROLETYPE_MODIFIED

Generated when a property of a role type is modified.

See Also:

Constant Field Values

ARCROLETYPE_ADD

public static final java.lang.String ARCROLETYPE_ADD

Generated when a new arc role type is added to the DTSContainer.

See Also:

Constant Field Values

ARCROLETYPE_DEL

public static final java.lang.String ARCROLETYPE_DEL

Generated when an arc role type is no longer used and removed from DTSContainer.

See Also:

Constant Field Values

ARCROLETYPE_MODIFIED

public static final java.lang.String ARCROLETYPE_MODIFIED

Generated when a property of an arc role type is modified.

See Also:

Constant Field Values

IXBRL_START

public static final java.lang.String IXBRL_START

Generated when the DTSContainer begins to convert an ixbrl to a xbrl.

See Also:

Constant Field Values

IXBRL_END

public static final java.lang.String IXBRL_END

Generated when the DTSContainer ends converting an ixbrl to a xbrl.

See Also:

Constant Field Values

UNDER_EVALUATION_INSTANCE

public static final java.lang.String UNDER_EVALUATION_INSTANCE

Generated when the instance document under evaluation is changed in the DTSContainer.

See Also:

Constant Field Values

ROLETYPE_VALIDATE_ROLEREF

public static final java.lang.String ROLETYPE_VALIDATE_ROLEREF

For internal use: this event is added to validate a roleRef and role resolves to the referenced role.

See Also:

Constant Field Values

ARCROLETYPE_VALIDATE_ARCROLEREF

public static final java.lang.String ARCROLETYPE_VALIDATE_ARCROLEREF

For internal use: this event is added to validate a arcroleRef and arcrole resolves to the referenced arcrole.

See Also:

Constant Field Values

INSTANCE_ADD

public static final java.lang.String INSTANCE_ADD

Generated when a new XBRL report is created.

See Also:

Constant Field Values

Constructor Detail

XBRLEvent

public XBRLEvent()

Method Detail

isFactUnitEvent

public static boolean isFactUnitEvent(java.beans.PropertyChangeEvent ppch)

Explores the PropertyChangeEvent received and returns true if the event is related with a change in the fact unit.

Parameters:

ppch - PropertyChangeEvent to explore

Returns:

true if ppch oldValue is XBRLFactNumeric and newValue is an array of which one value is of XBRLUnit type

isFactContextEvent

public static boolean isFactContextEvent(java.beans.PropertyChangeEvent ppch)

Explores the PropertyChangeEvent received and returns true if the event is related with a change in the fact context.

Parameters:

ppch - PropertyChangeEvent to explore

Returns:

true if ppch oldValue is XBRLFactItem and newValue is an array of which one value is of XBRLContext type