oracle.dss.util

Class CustomStyle

java.lang.Object

oracle.dss.util.CustomStyle

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

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

Constructor Summary

Constructors

Constructor and Description
CustomStyle()
CustomStyle(java.lang.Class object, java.lang.String stylePath)
CustomStyle(java.io.InputStream stream)
CustomStyle(java.lang.String xml)

Method Summary

Modifier and Type	Method and Description
CustomStyle	getBaseStyle() Retrieves the style upon which this style is based.
oracle.dss.util.persistence.PersistableAttributes	getPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes attrs) Retrieves the attributes of the component, for searching.
oracle.dss.util.persistence.AggregateInfo[]	getPersistableComponents() Retrieves a list of Persistable components that the component aggregates.
java.lang.String	getPersistableObjectType() Retrieves the Persistable object type for this CustomStyle.
java.lang.String	getTitle() Retrieves the title of this CustomStyle.
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	setBaseStyle(CustomStyle baseStyle) Specifies the CustomStyle that this CustomStyle is based on.
void	setPersistableAttributes(oracle.dss.util.persistence.PersistableAttributes attrs) Specifies attributes that can be used for searching in the BI Beans Catalog.
void	setPersistableComponents(oracle.dss.util.persistence.AggregateInfo[] persistables) Specifies a list of Persistable components that the component aggregates.
void	setPersistableObjectType(java.lang.String persistableObjectType) Specifies the Persistable object type for this CustomStyle.
void	setTitle(java.lang.String title) Specifies the title for this CustomStyle.
boolean	setXMLAsString(java.lang.String xml) Specifies the XML representation of the component.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomStyle

public CustomStyle()

For internal use only. Application developers should not use this

Constructor

CustomStyle

public CustomStyle(java.lang.String xml)

For internal use only. Application developers should not use this

Constructor

CustomStyle

public CustomStyle(java.lang.Class object,
                   java.lang.String stylePath)
            throws java.io.IOException

Throws:

java.io.IOException

For internal use only. Application developers should not use this

Constructor

CustomStyle

public CustomStyle(java.io.InputStream stream)
            throws java.io.IOException

Throws:

java.io.IOException

For internal use only. Application developers should not use this

Constructor

Method Detail

getBaseStyle

public CustomStyle getBaseStyle()

Retrieves the style upon which this style is based. Style property settings in this CustomStyle are added to the CustomStyle that this method returns. If this CustomStyle sets the same properties as the base style, then the settings in this CustomStyle take precedence.

Returns:

The CustomStyle upon which this CustomStyle is based.

setBaseStyle

public void setBaseStyle(CustomStyle baseStyle)

Specifies the CustomStyle that this CustomStyle is based on. Style property settings in this CustomStyle are added to the CustomStyle that you pass in this method. If this CustomStyle sets the same properties as the base style, then the settings in this CustomStyle take precedence.

Parameters:

baseStyle - The CustomStyle upon which to base this CustomStyle.

getTitle

public java.lang.String getTitle()

Retrieves the title of this CustomStyle.

Returns:

The title of this CustomStyle.

setTitle

public void setTitle(java.lang.String title)

Specifies the title for this CustomStyle. The title is the name that appears in the BI Beans Catalog.

Parameters:

title - The title for this CustomStyle.

getPersistableObjectType

public java.lang.String getPersistableObjectType()

Retrieves the Persistable object type for this CustomStyle.

Returns:

A constant that identifies the object type for this CustomStyle in the BI Beans Catalog.

See Also:

PersistableConstants.Attributes.OBJECT_TYPE, PersistableConstants.GRAPHSTYLE

setPersistableObjectType

public void setPersistableObjectType(java.lang.String persistableObjectType)

Specifies the Persistable object type for this CustomStyle.

Parameters:

persistableObjectType - A constant that identifies the object type for this CustomStyle in the BI Beans Catalog.

See Also:

PersistableConstants.Attributes.OBJECT_TYPE, PersistableConstants.GRAPHSTYLE

initialize

public void initialize(java.util.Hashtable env)

Description copied from interface: oracle.dss.util.persistence.SimplePersistable

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.

Specified by:

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

Parameters:

env - Environment properties.

For internal use only. Application developers should not use this

getPersistableComponents

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

Description copied from interface: oracle.dss.util.persistence.contract.AggregableContract

Retrieves a list of Persistable components that the component aggregates.

Specified by:

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

Returns:

Information about each component that the component aggregates.

For internal use only. Application developers should not use this

setPersistableComponents

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

Description copied from interface: oracle.dss.util.persistence.contract.AggregableContract

Specifies a list of Persistable components that the component aggregates.

Specified by:

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

Parameters:

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

For internal use only. Application developers should not use this

getPersistableAttributes

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

Description copied from interface: oracle.dss.util.persistence.SimplePersistable

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.

Specified by:

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

Parameters:

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

Returns:

The full set of attributes for the component.

For internal use only. Application developers should not use this

setPersistableAttributes

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

Description copied from interface: oracle.dss.util.persistence.SimplePersistable

Specifies attributes that can be used for searching in the BI Beans Catalog. These are attributes which are associated with the persisted object, accessible to all applications. To store application specific attributes, add oracle.dss.persistence.ApplicationAttribute instances to a BasicAttributes collection, and pass in to the bind method.

Specified by:

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

Parameters:

attrs - PersistableAttributes that specify search attributes for the component.

For internal use only. Application developers should not use this

getXMLAsString

public java.lang.String getXMLAsString()

Description copied from interface: oracle.dss.util.persistence.StringXMLizable

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 oracle.dss.util.persistence.StringXMLizable

Returns:

The XML representation of this component.

For internal use only. Application developers should not use this

setXMLAsString

public boolean setXMLAsString(java.lang.String xml)

Description copied from interface: oracle.dss.util.persistence.StringXMLizable

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 oracle.dss.util.persistence.StringXMLizable

Parameters:

xml - The XML representation of the component.

Returns:

true the XML was successfully set, false if not.

For internal use only. Application developers should not use this