oracle.odi.domain.mapping.properties

Class Property

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.root.Root

oracle.odi.domain.root.NamedObject

oracle.odi.domain.root.PropertyOwner

oracle.odi.domain.mapping.properties.Property

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IProperty, IRepositoryEntity, IMapExpressionOwner, oracle.odi.domain.mapping.IMapReferenceOwner, IMappingObject, INamedObject, IPropertyOwner, IRoot

@Entity
public class Property
extends oracle.odi.domain.root.PropertyOwner
implements IMapExpressionOwner, IProperty, oracle.odi.domain.mapping.IMapReferenceOwner

The property class for ODI properties. A set of properties can be owned by any object that extends from PropertyOwner. A property can own another set of properties.

The basic property implementation is a name/value pair. The PropertyOwner class has methods like getPropertyValue and setPropertyValue that find a property by name and set or get its value.

Properties have a type depending on the type of the persisted value. The defined types and persisted value types are:

Property Type	Persisted Value Type
STRING	String
EXPRESSION	MapExpression
XREF	MapReference

See Also:

PropertyDefinition, Serialized Form

Property Summary

Properties

Type	Property and Description
boolean	isPersistent Decides if this property is persistable.
boolean	isTransient Checks if this property is transient.

Field Summary

Fields inherited from class oracle.odi.domain.root.NamedObject

mGlobalNamespaceId

Method Summary

Methods

Modifier and Type	Method and Description
void	addChildProperty(Property childProperty) Adds a child property to this property.
java.util.List	getAllMapReferences()
Property	getChildProperty(java.lang.String key) Gets the child property object with the specified key name.
java.lang.Object	getChildPropertyValue(java.lang.String key) Gets the child property value for the child property with the specified name.
java.lang.Object	getDefaultValue() Gets the default value of this property.
java.lang.String	getDefaultValueString() Gets the default value as a String.
java.lang.String	getDisplayableTypeName() Get a user-displayable type name for the object.
java.lang.String	getDisplayName() Gets a displayable, translated name for the property.
java.lang.String	getDisplayNameKey() Gets the NLS display name key for the property.
MapExpression	getExpressionValue() Gets the expression value of the property, for properties of type EXPRESSION.
IMapRootContainer	getMapRootContainer() Get the owning root container for this object.
java.lang.Integer	getMaxLength() Gets the maximum length of this property, giving transient maximum length the priority.
java.lang.String	getName() Gets the name of the property.
IPropertyOwner	getOwner() Gets owner of this property.
PropertyDefinition	getPropertyDefinition() Gets the property definition used to create this property, if any.
oracle.odi.domain.root.PropertyOwner	getPropertyOwner() Gets the owner of this property.
java.util.List	getStringDomainValues() Returns a list of domain values of this property, giving transient domain values priority.
java.lang.String	getStringValue() Gets the string value of the property.
java.lang.String	getTranslatedDomainValue(java.lang.String value) Gets the NLS translated domain value of the domain value key.
PropertyDefinition.PropertyType	getType() Gets the type of this property.
java.lang.Object	getValue() Gets the value of the property.
java.lang.String	getValueDisplayType() Gets the value type for display.
java.util.List	getXRefDomainValues() Returns a list of the domain model object values that can be assigned as values for the XREF property.
boolean	isDefaultValue() Checks if this property's value is equals to the default value.
boolean	isPersistentProperty() Decides if this property is persistable.
boolean	isReadOnly() Checks if this property is read-only.
boolean	isTransientProperty() Checks if this property is transient.
void	setChildPropertyValue(java.lang.String key, java.lang.Object value) Sets a child property value, for the property with the specified key name.
void	setDomainValues(java.util.List domainValues) Sets the transient domain values for this property.
void	setTransientMaxLength(java.lang.Integer maxLength) Sets the transient maximum length of this property.
void	setValue(java.lang.Object value) Sets the object value of the property.
java.lang.String	toString()
boolean	validate(java.util.List result, boolean debug) Validates the value of this expression.

Methods inherited from class oracle.odi.domain.root.PropertyOwner

addProperty, adjustPropertyPersistency, createProperty, createProperty, delete, getAllProperties, getAllProperties, getAllPropertyMapReferenceOwners, getBooleanPropertyValue, getChildNamespaceId, getDisplayableProperties, getExpressionPropertyValue, getIntPropertyValue, getProperties, getProperties, getProperty, getPropertyMetadataOwner, getPropertyValue, getPropertyValueReference, getStringPropertyValue, initiateDynamicProperties, internalGetAllProperties, internalIsPropertyDefined, internalSetPropertyValue, invokeMethod, isPropertyDefined, notifyPropertyChange, onSave, removeAllProperties, removeProperty, removeProperty, setBooleanPropertyValue, setIntPropertyValue, setPropertyValue, validateProperties

Methods inherited from class oracle.odi.domain.root.NamedObject

getBusinessName, getDescription, getGlobalNamespaceId, getNamespaceId, setBusinessName, setDescription, setName

Methods inherited from class oracle.odi.domain.root.Root

addCachedIssue, addCachedIssues, clearIssueCache, displayIssues, displayIssues, displayIssues, dump, dump, dump, dump, dumpToString, equals, getAdapter, getCachedErrors, getCachedIssues, getCachedSyncState, getCachedValidationErrorMessage, getDisplayableObjectName, getFCOContainer, getFullName, getGUID, getInternalId, getPropertyDefinitionOwner, getRootContainer, getSecurityContainer, getStrongTypeClassName, getSyncState, handleMapChangeEvent, hasAdapter, hashCode, isNew, setCachedSyncState, validate

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor

Methods inherited from class oracle.odi.domain.support.BusinessObject

clone

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.odi.domain.root.IRoot

dump, dump, getDisplayableObjectName, getGUID, getStrongTypeClassName, validate

Methods inherited from interface oracle.odi.domain.root.IMappingObject

getRootContainer

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getInternalId, getSecurityContainer

Methods inherited from interface oracle.odi.domain.root.INamedObject

getBusinessName, getDescription, setBusinessName, setDescription, setName

Property Detail

isPersistent

Decides if this property is persistable. This is the key method for implementing the persistency policy for Property.

Note 1:The persistency policy for a property is as as follows:
Rule 1: Transient property is not persistable.

Rule 2: Property without definition is always persistable.
Rule 3: Property with dynamic default value is always persistable.
Rule 4: Property with static default is persistable only if the property value is not equal to the property's default value.
The goal of the above rules is to avoid persisting any Property instance whose value equals to its static default value.

Note 2: We have to persist property having dynamic default value even if the property value is equal to the default. This is because the current default value may become non-default at any moment.

Returns:

true if the property is persistable, false otherwise.

isTransient

Checks if this property is transient.

Note: A transient property is not persisted. However, there are non-transient properties that are also not persisted in repository. The method isPersistentProperty() implements the persistency rules.

Returns:

true if this property is transient, false otherwise.

See Also:

isPersistentProperty()

Constructor Detail

Property

public Property(PropertyDefinition propDef,
        oracle.odi.domain.root.PropertyOwner propertyOwner)
         throws MappingException

Parameters:

propDef - The property definition object that creates this property.

Throws:

PropertyException

MappingException

Property

public Property(PropertyDefinition.PropertyType type,
        oracle.odi.domain.root.PropertyOwner propertyOwner,
        java.lang.String name,
        java.lang.String displayNameKey)
         throws MappingException

Parameters:

propertyOwner - The owner of the property.

name - The name of the property.

displayNameKey - The NLS display name key for the property.

Throws:

PropertyException

MappingException

Property

public Property(oracle.odi.domain.root.PropertyOwner propertyOwner,
        java.lang.String name,
        java.lang.String displayNameKey,
        MapExpression value)
         throws MappingException

Parameters:

propertyOwner - The owner of the property.

name - The name of the property.

displayNameKey - The NLS display name key for the property.

value - The expression value of the property.

Throws:

PropertyException

MappingException

Method Detail

isPersistentProperty

public boolean isPersistentProperty()

Decides if this property is persistable. This is the key method for implementing the persistency policy for Property.

Note 1:The persistency policy for a property is as as follows:
Rule 1: Transient property is not persistable.

Rule 2: Property without definition is always persistable.
Rule 3: Property with dynamic default value is always persistable.
Rule 4: Property with static default is persistable only if the property value is not equal to the property's default value.
The goal of the above rules is to avoid persisting any Property instance whose value equals to its static default value.

Note 2: We have to persist property having dynamic default value even if the property value is equal to the default. This is because the current default value may become non-default at any moment.