com.ihr.xbrl.om.table.layout

Interface EditorSource

All Known Implementing Classes:

EditorSourceImpl

public interface EditorSource

The Editor source interface contains methods used by the table layout to obtain values that are in the GUI or related classes but are not yet part of the instance document. The values are injected in the open breakdowns and they might result in additional rows or columns

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
<T> void	processAspect(int aspect, javax.xml.namespace.QName dimensionName, java.util.Set<T> set, RSTableOpenFilter filter) An EditorSource must implement this method.
void	setDTSContainer(DTSContainer dts) Convenient method to reset the EditorSource content.

Method Detail

processAspect

<T> void processAspect(int aspect,
                       javax.xml.namespace.QName dimensionName,
                       java.util.Set<T> set,
                       RSTableOpenFilter filter)

An EditorSource must implement this method. The method will be called during the expansion process with the following parameters:

Type Parameters:

T - the generic type

Parameters:

aspect - this is the aspect code as defined in CommonAspectRule

dimensionName - when the aspect is com.ihr.xbrl.om.table.definition.CommonAspectRule.DIMENSION this parameter provides the dimension name

set - this is the set that contains values from the instance. The EditorSource might add new values to this set

filter - this parameter is optional, if present it represents a filter that will process values to return just some of the original values

setDTSContainer

void setDTSContainer(DTSContainer dts)

Convenient method to reset the EditorSource content. Implementations can clear all stored values when dts parameter is null

Parameters:

dts - the dts to store information for