oracle.adf.view.faces.bi.component
Class UIViewComponent

java.lang.Object
  javax.faces.component.UIComponent
      org.apache.myfaces.trinidad.component.UIXComponent
          org.apache.myfaces.trinidad.component.UIXComponentBase
              oracle.adf.view.faces.bi.component.BIComponentBase
                  oracle.adf.view.faces.bi.component.UIViewComponent

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

UIDataView

public abstract class UIViewComponent
extends BIComponentBase

This is the base class for all BI ADF Faces View Components such as Graph, Pivot Table, Table, Map, PagingControl and FTA. UIDataView extends this class. View Components that are not appropriate to extend UIDataView can extend this class directly for example FTA. Graph, Pivot Table and Table extend UIDataView. Map and PagingControl developers should decide if they should extend UIDataView or UIViewComponent. This class primarily contains base state implementation.

Since:

4.0

Field Summary

static org.apache.myfaces.trinidad.bean.FacesBean.Type

TYPE

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

UIViewComponent()

Method Summary

protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
abstract java.lang.String	getXMLAsString() Retrieves the XML representation of this CoreGraph.
abstract void	initialize(java.util.Hashtable env) The persistence service calls this method when the view is restored from the BI Beans Catalog.
abstract boolean	setXMLAsString(java.lang.String xml) Specifies the XML representation of this CoreGraph.
abstract void	specifyPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes attrs) Application developers do not need to call this method.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getFamily, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

Constructor Detail

UIViewComponent

public UIViewComponent()

Method Detail

setXMLAsString

public abstract boolean setXMLAsString(java.lang.String xml)
                                throws oracle.dss.util.persistence.BIPersistenceException

Specifies the XML representation of this CoreGraph. The persistence service calls this method when the view is restored from the BI Beans Catalog. Application developers should not call this method.

Parameters:

xml - The XML representation of the view.

Returns:

true if the XML was successfully set, false if not.

Throws:

oracle.dss.util.persistence.BIPersistenceException - If a problem occurs in setting the XML.

getXMLAsString

public abstract java.lang.String getXMLAsString()

Retrieves the XML representation of this CoreGraph. This method is called by the persistence service when you save the CoreGraph to the BI Beans Catalog.

Application developers should not call this method.

Returns:

The XML representation of this CoreGraph.

specifyPersistableAttributes

public abstract void specifyPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes attrs)

Application developers do not need to call this method. Views implementing this method should specify View specific attributes on the attrs object.

initialize

public abstract void initialize(java.util.Hashtable env)

The persistence service calls this method when the view is restored from the BI Beans Catalog. Application developers should not call this method.

Parameters:

env -

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class BIComponentBase