oracle.adf.view.faces.bi.event.pivotFilterBar

Class QueryPivotEvent

java.lang.Object

java.util.EventObject

javax.faces.event.FacesEvent

oracle.adf.view.faces.bi.event.pivotFilterBar.QueryPivotEvent

All Implemented Interfaces:

java.io.Serializable

public class QueryPivotEvent
extends javax.faces.event.FacesEvent

The QueryPivotEvent is delivered when a pivot operation is executed on the PivotFilterBar.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
QueryPivotEvent(javax.faces.component.UIComponent source, oracle.adf.view.rich.model.QueryDescriptor descriptor, java.lang.String fromAttribute, java.lang.String toAttribute, PivotableQueryDescriptor.PivotOperation operation) Constructs an instance of the QueryPivotEvent.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
oracle.adf.view.rich.model.QueryDescriptor	getDescriptor() Gets the payload of the event.
java.lang.String	getFromAttribute() Gets the name of the attribute in which the user pivots from.
PivotableQueryDescriptor.PivotOperation	getOperation() Gets the type of pivot operation.
java.lang.String	getToAttribute() Gets the name of the attribute in which the user pivots to.
int	hashCode()
boolean	isAppropriateListener(javax.faces.event.FacesListener listener)
void	processListener(javax.faces.event.FacesListener listener)
java.lang.String	toString()

Methods inherited from class javax.faces.event.FacesEvent

getComponent, getPhaseId, queue, setPhaseId

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryPivotEvent

public QueryPivotEvent(javax.faces.component.UIComponent source,
               oracle.adf.view.rich.model.QueryDescriptor descriptor,
               java.lang.String fromAttribute,
               java.lang.String toAttribute,
               PivotableQueryDescriptor.PivotOperation operation)

Constructs an instance of the QueryPivotEvent.

Parameters:

source - the component instance.

descriptor - the QueryDescriptor for the component.

fromAttribute - the name of the attribute in which the user pivots from.

toAttribute - the name of the attribute in which the user pivots to.

operation - the pivot operation.

Method Detail

getDescriptor

public oracle.adf.view.rich.model.QueryDescriptor getDescriptor()

Gets the payload of the event. QueryDescriptor identifies the query that needs to be executed in response to the event.

Returns:

the QueryDescriptor or the payload of the event.

getFromAttribute

public java.lang.String getFromAttribute()

Gets the name of the attribute in which the user pivots from.

Returns:

the name of the attribute in which the user pivots from.

getToAttribute

public java.lang.String getToAttribute()

Gets the name of the attribute in which the user pivots to.

Returns:

the name of the attribute in which the user pivots to.

getOperation

public PivotableQueryDescriptor.PivotOperation getOperation()

Gets the type of pivot operation.

Returns:

the type of pivot operation.

processListener

public void processListener(javax.faces.event.FacesListener listener)

Specified by:

processListener in class javax.faces.event.FacesEvent

isAppropriateListener

public boolean isAppropriateListener(javax.faces.event.FacesListener listener)

Specified by:

isAppropriateListener in class javax.faces.event.FacesEvent

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.util.EventObject