org.palo.api
Interface Consolidation

public interface Consolidation

Consolidation.

A instance of this class represents a consolidation of a PALO Element.

Consolidations can be constructed by invoking Dimension.newConsolidation(Element, Element, double) and are also returned from consolidated elements when calling Element.getConsolidations() or Element.getConsolidationAt(int).

Version:

$ID$

See Also:

PaloAPIException

Method Summary

Element	getChild() Returns the child Element of this consolidation.
Element	getParent() Returns the parent Element of this consolidation.
double	getWeight() The consolidation weight.

Method Detail

getParent

Element getParent()

Returns the parent Element of this consolidation.

Returns:

the parent Element of this consolidation.

getChild

Element getChild()

Returns the child Element of this consolidation.

Returns:

the child Element of this consolidation.

getWeight

double getWeight()

The consolidation weight. This weight is used as a factor on the element's value when the consolidated value is computed.

Returns:

the consolidation weight.