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

java.lang.Object
  oracle.adf.view.faces.bi.component.ViewPersistable

All Implemented Interfaces:

oracle.dss.util.persistence.CatLinkNode, oracle.dss.util.persistence.CatNode, oracle.dss.util.persistence.contract.AggregableContract, oracle.dss.util.persistence.contract.CustomXMLContract, oracle.dss.util.persistence.contract.OptionalContract, oracle.dss.util.persistence.Persistable, oracle.dss.util.persistence.SimplePersistable, oracle.dss.util.persistence.StringXMLizable

Direct Known Subclasses:

GaugePersistable, GraphPersistable

public abstract class ViewPersistable
extends java.lang.Object
implements oracle.dss.util.persistence.Persistable

ViewPersistable is a helper class for saving and loading BI View components to and from BICatalog. Every BI View Component has a corresponding ViewPersitable. For example, CoreGraph has GraphPersistable that extends ViewPersitable. The applications should set the View Component such as CoreGraph and its DataModel on ViewPeristable before saving the ViewPersistable. When the ViewPersistable is loaded from the Catalog, it contains the View Component and the DataModel. It is the applications respondibility to set the DataModel on the View Component.

Since:

4.0

Constructor Summary

ViewPersistable()

Method Summary

abstract DataModel	createDataModel()
DataModel	getDataModel() Retrieves the DataModel.
oracle.dss.util.persistence.PersistableAttributes	getPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes oldAttrs) Retrieves the attributes of this CoreGraph, for searching.
oracle.dss.util.persistence.AggregateInfo[]	getPersistableComponents() Retrieves the persistable components that this CoreGraph aggregates.
UIViewComponent	getUIViewComponent() Retrieves the UIViewComponent such as CoreGraph, CoreGauge etc.
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.
void	setDataModel(DataModel model) Specifies the DataModel.
void	setPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes attrs) Specifies persistable attributes that can be used in searches of the repository.
void	setPersistableComponents(oracle.dss.util.persistence.AggregateInfo[] persistables) Specifies the components (e.g.
void	setUIViewComponent(UIViewComponent baseComp) Specifies the UIViewComponent.
boolean	setXMLAsString(java.lang.String xml) Specifies the XML representation of this ViewPersistable.

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewPersistable

public ViewPersistable()

Method Detail

getUIViewComponent

public UIViewComponent getUIViewComponent()

Retrieves the UIViewComponent such as CoreGraph, CoreGauge etc. The application first load the ViewPersistable from the catalog and then retrieves the UIViewComponent from this method. The applications can specify the UIViewComponent on the jspx page using component binding or programmatically add it to the component tree.

Returns:

the UIViewComponent

setUIViewComponent

public void setUIViewComponent(UIViewComponent baseComp)

Specifies the UIViewComponent. Applications should specify the UIViewComponent before saving the ViewPersistable to the catalog.

Parameters:

baseComp -

setDataModel

public void setDataModel(DataModel model)

Specifies the DataModel. Applications should specify the DataModel associated with the UIViewComponent before saving the ViewPersistable to the catalog.

Parameters:

model -

getDataModel

public DataModel getDataModel()

Retrieves the DataModel. The applications should retrive the DataModel after loading the ViewPersistable from the catalog and specify it on the UIViewComponent.

Returns:

the DataModel

setXMLAsString

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

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

Specified by:

setXMLAsString in interface oracle.dss.util.persistence.StringXMLizable

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 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.

Specified by:

getXMLAsString in interface oracle.dss.util.persistence.StringXMLizable

Returns:

The XML representation of this CoreGraph.

setPersistableAttributes

public void setPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes attrs)

Specifies persistable attributes that can be used in searches of the repository. This implementation does nothing. Application developers should not call this method.

Specified by:

setPersistableAttributes in interface oracle.dss.util.persistence.SimplePersistable

Parameters:

attrs - Any PersistableAttributes.

getPersistableAttributes

public oracle.dss.util.persistence.PersistableAttributes getPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes oldAttrs)

Retrieves the attributes of this CoreGraph, for searching. This method adds the attributes that this CoreGraph defines to the attributes that the application has specified. The attributes are used by the persistence service, when users search the repository for components that have particular attribute values. Application developers should not call this method.

Specified by:

getPersistableAttributes in interface oracle.dss.util.persistence.SimplePersistable

Parameters:

oldAttrs - The searchable attributes that the application has specified for this Dataview.

Returns:

A PersistableAttributes that includes the application specified attributes as well as the attributes that are specific to this CoreGraph.

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.

Specified by:

initialize in interface oracle.dss.util.persistence.SimplePersistable

Parameters:

env -

getPersistableComponents

public oracle.dss.util.persistence.AggregateInfo[] getPersistableComponents()

Retrieves the persistable components that this CoreGraph aggregates. CoreGraph objects aggregate the data source that defines the data that view displays.

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

Specified by:

getPersistableComponents in interface oracle.dss.util.persistence.contract.AggregableContract

Returns:

The data source for this CoreGraph, in an AggregateInfo array.

setPersistableComponents

public void setPersistableComponents(oracle.dss.util.persistence.AggregateInfo[] persistables)

Specifies the components (e.g. dataSource) associateds with the view. Application developers should not call this method.

Specified by:

setPersistableComponents in interface oracle.dss.util.persistence.contract.AggregableContract

Parameters:

persistables - a AggregateInfo[] value that represents the components to assign to the view.

createDataModel

public abstract DataModel createDataModel()