oracle.dss.util.persistence
Interface Persistable

All Superinterfaces:

StringXMLizable

All Known Subinterfaces:

BeanRef, MDPersistable, ThinDataviewCommon

All Known Implementing Classes:

BaseCachedDataSource, CalcStep, Connection, CustomStyle, Dataview, DataviewCache, MetadataManager, PersistableAdapter, Query, RankStep, RelationshipCalcStep, RelationshipIndexStep, RelationshipShareStep, Selection, SimpleMathCalcStep, ThinDataview, TimeCalcStep, TimeCumulativeTotalStep, TimeLagLeadStep, TimeMovingStep, TimeYearToDateStep, UIFormat, UIStyle

public interface Persistable

extends StringXMLizable

Methods for retrieving and restoring the state of a component. Also methods for retrieving and restoring relationships between components. Any component that needs to be persisted in the BI Beans Catalog must implement this interface.

Method Summary

PersistableAttributes	getPersistableAttributes(PersistableAttributes attrs) Retrieves the attributes of the component, for searching.
AggregateInfo[]	getPersistableComponents() Retrieves a list of Persistable components that the component aggregates.
void	initialize(java.util.Hashtable env) Initializes the component with the persistence environment.
void	setPersistableAttributes(PersistableAttributes attrs) Specifies attributes that can be used for searching in the BI Beans Catalog.
void	setPersistableComponents(AggregateInfo[] persistables) Specifies a list of Persistable components that the component aggregates.

Methods inherited from interface oracle.dss.util.persistence.StringXMLizable

getXMLAsString, setXMLAsString

Method Detail

initialize

public void initialize(java.util.Hashtable env)

Initializes the component with the persistence environment. The persistence service calls this method when it loads the component, so that the component can use environment properties to initialize itself. Environment properties are defined in the Context interface in JNDI.

Parameters:

env - Environment properties.

getPersistableComponents

public AggregateInfo[] getPersistableComponents()

Retrieves a list of Persistable components that the component aggregates.

Returns:

Information about each component that the component aggregates.

setPersistableComponents

public void setPersistableComponents(AggregateInfo[] persistables)

Specifies a list of Persistable components that the component aggregates.

Parameters:

persistables - An AggregateInfo for each component that this component has.

getPersistableAttributes

public PersistableAttributes getPersistableAttributes(PersistableAttributes attrs)

Retrieves the attributes of the component, for searching. The attributes are used by the persistence service, when users search the BI Beans Catalog for components that have particular attribute values.

Parameters:

attrs - The searchable attributes that the application has defined for this component.

Returns:

The full set of attributes for the component.

setPersistableAttributes

public void setPersistableAttributes(PersistableAttributes attrs)

Specifies attributes that can be used for searching in the BI Beans Catalog.

Parameters:

attrs - PersistableAttributes that specify search attributes for the component.