oracle.odi.domain.mapping.properties

Class Property

java.lang.Object

PropertyOwner

oracle.odi.domain.mapping.properties.Property

All Implemented Interfaces:

IProperty, IRepositoryEntity, IMapExpressionOwner, IMappingObject, IRoot

@Entity
public class Property
extends PropertyOwner
implements IMapExpressionOwner, IProperty

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

Property Summary

Type	Property and Description
boolean	isPersistent Gets the value of the property persistentProperty.
boolean	isTransient Gets the value of the property transientProperty.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMPTY_STRING_VALUE

Method Summary

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	getDisplayableObjectName() Return a user-displayable name for this object.
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.
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.
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() Gets the value of the property persistentProperty.
boolean	isReadOnly() Checks if this property is read-only.
boolean	isTransientProperty() Gets the value of the property transientProperty.
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 java.lang.Object

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

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

dump, dump, getGUID, getStrongTypeClassName, validate, validate

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

getRootContainer

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getInternalId, getParent

Property Detail

isPersistent

public boolean isPersistentProperty

Gets the value of the property persistentProperty.

isTransient

public boolean isTransientProperty

Gets the value of the property transientProperty.

Field Detail

EMPTY_STRING_VALUE

public static final java.lang.String EMPTY_STRING_VALUE

See Also:

Constant Field Values

Method Detail

isPersistentProperty

public boolean isPersistentProperty()

Gets the value of the property persistentProperty.

isTransientProperty

public boolean isTransientProperty()

Gets the value of the property transientProperty.

getOwner

public IPropertyOwner getOwner()

Gets owner of this property.

Specified by:

getOwner in interface IRoot

Returns:

the owner.

getPropertyOwner

public PropertyOwner getPropertyOwner()

Gets the owner of this property. Each property has at most one owner.

Returns:

the owner of this property.

getPropertyDefinition

public PropertyDefinition getPropertyDefinition()

Gets the property definition used to create this property, if any.

Returns:

the property definition of this property, or null if this property is transient.

getName

public java.lang.String getName()

Gets the name of the property. The property is always referenced by name.

Specified by:

getName in interface IProperty

Specified by:

getName in interface IMapExpressionOwner

Specified by:

getName in interface IRoot

Returns:

The property name.

getDisplayableObjectName

public java.lang.String getDisplayableObjectName()

Description copied from interface: IRoot

Return a user-displayable name for this object.

Specified by:

getDisplayableObjectName in interface IRoot

getDisplayName

public java.lang.String getDisplayName()

Gets a displayable, translated name for the property.

Returns:

the diaplay name for this property.

getType

public PropertyDefinition.PropertyType getType()

Gets the type of this property.

Returns:

the type of this property.

isReadOnly

public boolean isReadOnly()

Checks if this property is read-only.

Returns:

true if this property is read-only, false otherwise.

getStringValue

public java.lang.String getStringValue()
                                throws PropertyException

Gets the string value of the property. All extended property classes are required to return some meaningful value for this method.

Returns:

the String representation of the value of this property.

Throws:

PropertyException

setValue

public void setValue(java.lang.Object value)
              throws PropertyException

Sets the object value of the property. For the base property class, the value is stored as a string, so the object is converted to a string.

Parameters:

value - the new object value for this property.

Throws:

PropertyException

addChildProperty

public void addChildProperty(Property childProperty)
                      throws PropertyException

Adds a child property to this property. Any property can have children. The child properties are referenced by name, just like properties of any other object.

Parameters:

childProperty - the child property to add to this property.

Throws:

PropertyException

getChildProperty

public Property getChildProperty(java.lang.String key)
                          throws PropertyException

Gets the child property object with the specified key name.

Parameters:

key - the name of the child property to be retrieved.

Returns:

the property object.

Throws:

PropertyException

setChildPropertyValue

public void setChildPropertyValue(java.lang.String key,
                                  java.lang.Object value)
                           throws PropertyException

Sets a child property value, for the property with the specified key name.

Parameters:

key - the name of the child property to set.

value - the new value for the child property.

Throws:

PropertyException

getChildPropertyValue

public java.lang.Object getChildPropertyValue(java.lang.String key)
                                       throws PropertyException

Gets the child property value for the child property with the specified name.

Parameters:

key - the key name of the child property value to get.

Returns:

the property value.

Throws:

PropertyException

getValue

public java.lang.Object getValue()
                          throws PropertyException

Gets the value of the property.

Returns:

the value of this property.

Throws:

PropertyException

getExpressionValue

public MapExpression getExpressionValue()
                                 throws PropertyException

Gets the expression value of the property, for properties of type EXPRESSION. If property type is not EXPRESSION, returns null.

Returns:

the expression value of this property, or null if this is not of EXPRESSION type.

Throws:

PropertyException

MapComponentException

getStringDomainValues

public java.util.List getStringDomainValues()

Returns a list of domain values of this property, giving transient domain values priority. If transient domain values are set through setDomainValues(List), the String values of the transient domain objects are returned, otherwise, the domain values from PropertyDefinition are retrieved and returned.

Returns:

the list containing the domain values.

Throws:

PropertyException

getXRefDomainValues

public java.util.List getXRefDomainValues()
                                   throws PropertyException

Returns a list of the domain model object values that can be assigned as values for the XREF property. Used only for properties of type XREF.

Returns:

the list containing the domain values.

Throws:

PropertyException

getTranslatedDomainValue

public java.lang.String getTranslatedDomainValue(java.lang.String value)

Gets the NLS translated domain value of the domain value key.

Parameters:

value - the domain value key.

Returns:

the translated domain value.

getDefaultValue

public java.lang.Object getDefaultValue()

Gets the default value of this property. If this property has a defined dynamic default value, the dynamic default value is calculated, and returned, otherwise, the statically defined default value from PropertyDefinition is retrieved and returned.

Returns:

the object representing the default value of this property.

getDefaultValueString

public java.lang.String getDefaultValueString()

Gets the default value as a String.

Returns:

the String value of the default value of this property.

setDomainValues

public void setDomainValues(java.util.List domainValues)

Sets the transient domain values for this property. The domain values set through this method is not persisted in repository.

Parameters:

domainValues - the transient domain values.

getValueDisplayType

public java.lang.String getValueDisplayType()

Gets the value type for display.

Returns:

the display type of this property.

isDefaultValue

public boolean isDefaultValue()

Checks if this property's value is equals to the default value.

Returns:

true if this property value is equal to the property's default.

Throws:

PropertyException

validate

public boolean validate(java.util.List result,
                        boolean debug)

Validates the value of this expression.

Specified by:

validate in interface IRoot

Parameters:

result - a list of issues found during validation

debug - If true, then informational issues are added that provide information about the structure of the metadata and the state of this object.

Returns:

true if any errors were found, else false.

getDisplayableTypeName

public java.lang.String getDisplayableTypeName()

Description copied from interface: IRoot

Get a user-displayable type name for the object.

Specified by:

getDisplayableTypeName in interface IRoot

getMapRootContainer

public IMapRootContainer getMapRootContainer()

Description copied from interface: IMapExpressionOwner

Get the owning root container for this object.

Specified by:

getMapRootContainer in interface IMapExpressionOwner

toString

public java.lang.String toString()

getMaxLength

public java.lang.Integer getMaxLength()

Gets the maximum length of this property, giving transient maximum length the priority. If the transient maximum length is set through method setTransientMaxLength, the transient maximum length is returned, otherwise, the maximum length from PropertyDefinition is returned.

Returns:

the current maximum length of the property.

See Also:

PropertyDefinition.getMaxLength(), setTransientMaxLength(Integer)

setTransientMaxLength

public void setTransientMaxLength(java.lang.Integer maxLength)

Sets the transient maximum length of this property. The maximum length set this way will not be persisted in repository. The persisted maximum length of a property is defined in PropertyDefinition.

Parameters:

maxLength - the transient maximum length of this property.

See Also:

PropertyDefinition.getMaxLength()

getAllMapReferences

public java.util.List getAllMapReferences()