Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.util.persistence
Class PersistableAttributes

java.lang.Object
  |
  +--oracle.dss.util.persistence.PersistableAttributes
All Implemented Interfaces:
java.io.Serializable

public class PersistableAttributes
extends java.lang.Object
implements java.io.Serializable

The PersistableAttributes class contains searchable attributes for a Persistable components. It contains methods for retrieving and setting the value of an attribute, as well as checking whether the attribute has been already set. Finally, you could merge two PersistableAttributes together to form a single PersistableAttributes object.

See Also:
Serialized Form

Constructor Summary
PersistableAttributes()
          Default constructor for PersistableAttributes
PersistableAttributes(java.lang.String objType, int version, java.lang.String title, java.lang.String compSubType1, java.lang.String compSubType2, java.lang.String compSubType3)
          Constructor for PersistableAttributes

 

Method Summary
 void clearUsedBits()
          Sets all of the "used" PersistableAttributes attributes to false.
 java.lang.Object clone()
          Creates a clone of this PersistableAttribute instance
 java.lang.String getApplication()
          Retrieves the value of the Application attribute
 java.lang.String getApplicationSubType()
          Retrieves the value of the ApplicationSubType attribute
 java.lang.String getCompSubType1()
          Retrieves the value of the CompSubType1 attribute
 java.lang.String getCompSubType2()
          Retrieves the value of the CompSubType2 attribute
 java.lang.String getCompSubType3()
          Retrieves the value of the CompSubType3 attribute
 java.lang.String getDatabase()
          Retrieves the value of the Database attribute
 java.lang.String getDescription()
          Retrieves the value of the Description attribute
 java.lang.String getKeywords()
          Retrieves the value of the Keywords attribute
 java.lang.String getObjectName()
          Retrieves the value of the ObjectName attribute
 java.lang.String getObjectType()
          Retrieves the value of the ObjectType attribute
 int getObjectTypeVersion()
          Retrieves the value of the ObjectTypeVersion attribute
 java.lang.String getTitle()
          Retrieves the value of the Title attribute
 boolean isAnythingOverridden()
          Indicates whether any of the attribute of this ViewFormat has been explicitly set.
 boolean isApplicationSubTypeUsed()
          Indicates whether the Database attribute has been explicitly set.
 boolean isApplicationUsed()
          Indicates whether the Application attribute has been explicitly set.
 boolean isCompSubType1Used()
          Indicates whether the CompSubType1 attribute has been explicitly set.
 boolean isCompSubType2Used()
          Indicates whether the CompSubType2 attribute has been explicitly set.
 boolean isCompSubType3Used()
          Indicates whether the CompSubtype3 attribute has been explicitly set.
 boolean isDatabaseUsed()
          Indicates whether the Database attribute has been explicitly set.
 boolean isDescriptionUsed()
          Indicates whether the Description attribute has been explicitly set.
 boolean isKeywordsUsed()
          Indicates whether the Keywords attribute has been explicitly set.
 boolean isObjectNameUsed()
          Indicates whether the ObjectName attribute has been explicitly set.
 boolean isObjectTypeUsed()
          Indicates whether the ObjectType attribute has been explicitly set.
 boolean isObjectTypeVersionUsed()
          Indicates whether the ObjectTypeVersion attribute has been explicitly set.
 boolean isTitleUsed()
          Indicates whether the ObjectTypeVersion attribute has been explicitly set.
 void merge(PersistableAttributes from)
          Merges the specified PersistableAttributes object with this object.
 void setApplication(java.lang.String app)
          Sets the value of the Application attribute
 void setApplicationSubType(java.lang.String appSubType)
          Sets the value of the ApplicationSubType attribute
 void setApplicationSubTypeUsed(boolean bValue)
          Specifies whether the ApplicationSubType attribute has been explicitly set.
 void setApplicationUsed(boolean bValue)
          Specifies whether the Application attribute has been explicitly set.
 void setCompSubType1(java.lang.String compSubType1)
          Sets the value of the CompSubType1 attribute Length of the value cannot exceed 32 characters.
 void setCompSubType1Used(boolean bValue)
          Specifies whether the CompSubType1 attribute has been explicitly set.
 void setCompSubType2(java.lang.String compSubType2)
          Sets the value of the CompSubType2 attribute Length of the value cannot exceed 32 characters.
 void setCompSubType2Used(boolean bValue)
          Specifies whether the CompSubtype2 attribute has been explicitly set.
 void setCompSubType3(java.lang.String compSubType3)
          Sets the value of the CompSubType3 attribute.
 void setCompSubType3Used(boolean bValue)
          Specifies whether the CompSubType3 attribute has been explicitly set.
 void setDatabase(java.lang.String db)
          Sets the value of the Database attribute
 void setDatabaseUsed(boolean bValue)
          Specifies whether the Database attribute has been explicitly set.
 void setDescription(java.lang.String desc)
          Sets the value of the Description attribute
 void setDescriptionUsed(boolean bValue)
          Specifies whether the Description attribute has been explicitly set.
 void setKeywords(java.lang.String keywords)
          Sets the value of the Keywords attribute
 void setKeywordsUsed(boolean bValue)
          Specifies whether the Keywords attribute has been explicitly set.
 void setObjectName(java.lang.String name)
          Sets the value of the ObjectName attribute
 void setObjectNameUsed(boolean bValue)
          Specifies whether the ObjectName attribute has been explicitly set.
 void setObjectType(java.lang.String objType)
          Sets the value of the ObjectType attribute
 void setObjectTypeUsed(boolean bValue)
          Specifies whether the ObjectType attribute has been explicitly set.
 void setObjectTypeVersion(int version)
          Sets the value of the ObjectTypeVersion attribute
 void setObjectTypeVersionUsed(boolean bValue)
          Specifies whether the ObjectTypeVersion attribute has been explicitly set.
 void setTitle(java.lang.String title)
          Sets the value of the Title attribute
 void setTitleUsed(boolean bValue)
          Specifies whether the Title attribute has been explicitly set.

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

PersistableAttributes

public PersistableAttributes(java.lang.String objType,
                             int version,
                             java.lang.String title,
                             java.lang.String compSubType1,
                             java.lang.String compSubType2,
                             java.lang.String compSubType3)
Constructor for PersistableAttributes

PersistableAttributes

public PersistableAttributes()
Default constructor for PersistableAttributes
Method Detail

isAnythingOverridden

public boolean isAnythingOverridden()
Indicates whether any of the attribute of this ViewFormat has been explicitly set.
Returns:
true if any attribute has been explicitly set, false if the attributes have their original values.

clearUsedBits

public void clearUsedBits()
Sets all of the "used" PersistableAttributes attributes to false. Immediately after you call this method, the IsAnythingOverridden method returns false.

clone

public java.lang.Object clone()
Creates a clone of this PersistableAttribute instance

merge

public void merge(PersistableAttributes from)
Merges the specified PersistableAttributes object with this object. This method is called by the Rule classes.
Parameters:
from - The PersistableAttributes object that you want to merge.

isObjectNameUsed

public boolean isObjectNameUsed()
Indicates whether the ObjectName attribute has been explicitly set. When the return value of this method is true, the attribute's value will be used in the merging process.
Returns:
true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

setObjectNameUsed

public void setObjectNameUsed(boolean bValue)
Specifies whether the ObjectName attribute has been explicitly set. When the parameter value of this method is true, the attribute's value will be used in the merging process. The parameter value of this method is called by the setNumberType method.
Parameters:
bValue - true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

getObjectName

public java.lang.String getObjectName()
Retrieves the value of the ObjectName attribute

setObjectName

public void setObjectName(java.lang.String name)
Sets the value of the ObjectName attribute
Parameters:
name - - the value of the ObjectName attribute

isDescriptionUsed

public boolean isDescriptionUsed()
Indicates whether the Description attribute has been explicitly set. When the return value of this method is true, the attribute's value will be used in the merging process.
Returns:
true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

setDescriptionUsed

public void setDescriptionUsed(boolean bValue)
Specifies whether the Description attribute has been explicitly set. When the parameter value of this method is true, the attribute's value will be used in the merging process. The parameter value of this method is called by the setNumberType method.
Parameters:
bValue - true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

getDescription

public java.lang.String getDescription()
Retrieves the value of the Description attribute

setDescription

public void setDescription(java.lang.String desc)
Sets the value of the Description attribute
Parameters:
name - - the value of the Description attribute

isKeywordsUsed

public boolean isKeywordsUsed()
Indicates whether the Keywords attribute has been explicitly set. When the return value of this method is true, the attribute's value will be used in the merging process.
Returns:
true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

setKeywordsUsed

public void setKeywordsUsed(boolean bValue)
Specifies whether the Keywords attribute has been explicitly set. When the parameter value of this method is true, the attribute's value will be used in the merging process. The parameter value of this method is called by the setNumberType method.
Parameters:
bValue - true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

getKeywords

public java.lang.String getKeywords()
Retrieves the value of the Keywords attribute

setKeywords

public void setKeywords(java.lang.String keywords)
Sets the value of the Keywords attribute
Parameters:
name - - the value of the Keywords attribute

isApplicationUsed

public boolean isApplicationUsed()
Indicates whether the Application attribute has been explicitly set. When the return value of this method is true, the attribute's value will be used in the merging process.
Returns:
true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

setApplicationUsed

public void setApplicationUsed(boolean bValue)
Specifies whether the Application attribute has been explicitly set. When the parameter value of this method is true, the attribute's value will be used in the merging process. The parameter value of this method is called by the setNumberType method.
Parameters:
bValue - true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

getApplication

public java.lang.String getApplication()
Retrieves the value of the Application attribute

setApplication

public void setApplication(java.lang.String app)
Sets the value of the Application attribute
Parameters:
name - - the value of the Application attribute

isDatabaseUsed

public boolean isDatabaseUsed()
Indicates whether the Database attribute has been explicitly set. When the return value of this method is true, the attribute's value will be used in the merging process.
Returns:
true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

setDatabaseUsed

public void setDatabaseUsed(boolean bValue)
Specifies whether the Database attribute has been explicitly set. When the parameter value of this method is true, the attribute's value will be used in the merging process. The parameter value of this method is called by the setNumberType method.
Parameters:
bValue - true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

getDatabase

public java.lang.String getDatabase()
Retrieves the value of the Database attribute

setDatabase

public void setDatabase(java.lang.String db)
Sets the value of the Database attribute
Parameters:
name - - the value of the Database attribute

isApplicationSubTypeUsed

public boolean isApplicationSubTypeUsed()
Indicates whether the Database attribute has been explicitly set. When the return value of this method is true, the attribute's value will be used in the merging process.
Returns:
true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

setApplicationSubTypeUsed

public void setApplicationSubTypeUsed(boolean bValue)
Specifies whether the ApplicationSubType attribute has been explicitly set. When the parameter value of this method is true, the attribute's value will be used in the merging process. The parameter value of this method is called by the setNumberType method.
Parameters:
bValue - true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

getApplicationSubType

public java.lang.String getApplicationSubType()
Retrieves the value of the ApplicationSubType attribute

setApplicationSubType

public void setApplicationSubType(java.lang.String appSubType)
Sets the value of the ApplicationSubType attribute
Parameters:
name - - the value of the ApplicationSubType attribute

isObjectTypeUsed

public boolean isObjectTypeUsed()
Indicates whether the ObjectType attribute has been explicitly set. When the return value of this method is true, the attribute's value will be used in the merging process.
Returns:
true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

setObjectTypeUsed

public void setObjectTypeUsed(boolean bValue)
Specifies whether the ObjectType attribute has been explicitly set. When the parameter value of this method is true, the attribute's value will be used in the merging process. The parameter value of this method is called by the setNumberType method.
Parameters:
bValue - true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

getObjectType

public java.lang.String getObjectType()
Retrieves the value of the ObjectType attribute

setObjectType

public void setObjectType(java.lang.String objType)
Sets the value of the ObjectType attribute
Parameters:
name - - the value of the ObjectType attribute

isObjectTypeVersionUsed

public boolean isObjectTypeVersionUsed()
Indicates whether the ObjectTypeVersion attribute has been explicitly set. When the return value of this method is true, the attribute's value will be used in the merging process.
Returns:
true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

setObjectTypeVersionUsed

public void setObjectTypeVersionUsed(boolean bValue)
Specifies whether the ObjectTypeVersion attribute has been explicitly set. When the parameter value of this method is true, the attribute's value will be used in the merging process. The parameter value of this method is called by the setNumberType method.
Parameters:
bValue - true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

getObjectTypeVersion

public int getObjectTypeVersion()
Retrieves the value of the ObjectTypeVersion attribute

setObjectTypeVersion

public void setObjectTypeVersion(int version)
Sets the value of the ObjectTypeVersion attribute
Parameters:
name - - the value of the ObjectTypeVersion attribute

isTitleUsed

public boolean isTitleUsed()
Indicates whether the ObjectTypeVersion attribute has been explicitly set. When the return value of this method is true, the attribute's value will be used in the merging process.
Returns:
true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

setTitleUsed

public void setTitleUsed(boolean bValue)
Specifies whether the Title attribute has been explicitly set. When the parameter value of this method is true, the attribute's value will be used in the merging process. The parameter value of this method is called by the setNumberType method.
Parameters:
bValue - true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

getTitle

public java.lang.String getTitle()
Retrieves the value of the Title attribute

setTitle

public void setTitle(java.lang.String title)
Sets the value of the Title attribute
Parameters:
name - - the value of the Title attribute

isCompSubType1Used

public boolean isCompSubType1Used()
Indicates whether the CompSubType1 attribute has been explicitly set. When the return value of this method is true, the attribute's value will be used in the merging process.
Returns:
true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

setCompSubType1Used

public void setCompSubType1Used(boolean bValue)
Specifies whether the CompSubType1 attribute has been explicitly set. When the parameter value of this method is true, the attribute's value will be used in the merging process. The parameter value of this method is called by the setNumberType method.
Parameters:
bValue - true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

getCompSubType1

public java.lang.String getCompSubType1()
Retrieves the value of the CompSubType1 attribute

setCompSubType1

public void setCompSubType1(java.lang.String compSubType1)
Sets the value of the CompSubType1 attribute Length of the value cannot exceed 32 characters.
Parameters:
name - - the value of the CompSubType1 attribute

isCompSubType2Used

public boolean isCompSubType2Used()
Indicates whether the CompSubType2 attribute has been explicitly set. When the return value of this method is true, the attribute's value will be used in the merging process.
Returns:
true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

setCompSubType2Used

public void setCompSubType2Used(boolean bValue)
Specifies whether the CompSubtype2 attribute has been explicitly set. When the parameter value of this method is true, the attribute's value will be used in the merging process. The parameter value of this method is called by the setNumberType method.
Parameters:
bValue - true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

getCompSubType2

public java.lang.String getCompSubType2()
Retrieves the value of the CompSubType2 attribute

setCompSubType2

public void setCompSubType2(java.lang.String compSubType2)
Sets the value of the CompSubType2 attribute Length of the value cannot exceed 32 characters.
Parameters:
name - - the value of the CompSubType2 attribute

isCompSubType3Used

public boolean isCompSubType3Used()
Indicates whether the CompSubtype3 attribute has been explicitly set. When the return value of this method is true, the attribute's value will be used in the merging process.
Returns:
true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

setCompSubType3Used

public void setCompSubType3Used(boolean bValue)
Specifies whether the CompSubType3 attribute has been explicitly set. When the parameter value of this method is true, the attribute's value will be used in the merging process. The parameter value of this method is called by the setNumberType method.
Parameters:
bValue - true if the attribute has been explicitly set, false if the attribute has not been explicitly set.

getCompSubType3

public java.lang.String getCompSubType3()
Retrieves the value of the CompSubType3 attribute

setCompSubType3

public void setCompSubType3(java.lang.String compSubType3)
Sets the value of the CompSubType3 attribute. Length of the value cannot exceed 32 characters.
Parameters:
name - - the value of the CompSubType3 attribute

Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


Copyright © 2003, Oracle. All Rights Reserved.