oracle.dss.util.persistence
Class PersistableAdapter

java.lang.Object
  |
  +--oracle.dss.util.persistence.PersistableAdapter

All Implemented Interfaces:

Persistable, StringXMLizable

public class PersistableAdapter

extends java.lang.Object

implements Persistable

The PersistableAdapter class provides a default implementation of the Persistable interface.

Constructor Summary

PersistableAdapter(java.lang.String type)
Constructor of this class that takes an object type as the argument.

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.
java.lang.String	getXMLAsString() Retrieves the XML representation of the component.
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 repository.
void	setPersistableComponents(AggregateInfo[] persistables) Specifies a list of Persistable components that the component aggregates.
boolean	setXMLAsString(java.lang.String xml) Specifies the XML representation of the component.

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistableAdapter

public PersistableAdapter(java.lang.String type)

Constructor of this class that takes an object type as the argument.

Parameters:

type - The type of this Persistable object

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.

Specified by:

initialize in interface Persistable

Parameters:

env - Environment properties.

getPersistableComponents

public AggregateInfo[] getPersistableComponents()

Retrieves a list of Persistable components that the component aggregates.

Specified by:

getPersistableComponents in interface Persistable

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.

Specified by:

setPersistableComponents in interface Persistable

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 repository for components that have particular attribute values.

Specified by:

getPersistableAttributes in interface Persistable

Parameters:

attrs - The searchable attributes that the application has defined for this component. This parameter is ignored.

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

Specified by:

setPersistableAttributes in interface Persistable

Parameters:

attrs - PersistableAttributes that specify search attributes for the component.

getXMLAsString

public java.lang.String getXMLAsString()
                                throws BIPersistenceException

Retrieves the XML representation of the component. This method is called by the persistence service when the component is saved to the BI Beans Catalog.

Specified by:

getXMLAsString in interface StringXMLizable

Returns:

The XML representation of this component.

setXMLAsString

public boolean setXMLAsString(java.lang.String xml)
                       throws BIPersistenceException

Specifies the XML representation of the component. The persistence service calls this method when the component is restored from the BI Beans Catalog.

Specified by:

setXMLAsString in interface StringXMLizable

Parameters:

name - The XML representation of the component.

Returns:

true the XML was successfully set, false if not.

Throws:

BIPersistenceException - If a problem occurs in setting the XML.