oracle.odi.domain.mapping.properties

Class PropertyDefinition

java.lang.Object

FCORoot

oracle.odi.domain.mapping.properties.PropertyDefinition

All Implemented Interfaces:

IPropertyDefinition, IRepositoryEntity, IPropertyDefinitionOwner, IMappingObject, IRoot

@Entity
public class PropertyDefinition
extends FCORoot
implements IPropertyDefinition, IPropertyDefinitionOwner

A class representing a property definition for a component type or class type. The property definition contains all the information needed to create the property when a new class instance is created.

Property Summary

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertyDefinition.PropertyType The types of properties that are defined.

Method Summary

Modifier and Type	Method and Description
PropertyDefinition	findPropertyDefinition(java.lang.String ownerClass, java.lang.String name) Finds the property definition with the specified name, or null if not found.
PropertyDefinition	getChildDef(int index) Gets the child property definition at the specified index.
java.util.List	getChildDefs() Gets a list of all child property definitions owned by this property definition.
java.lang.String	getDefaultValue() Gets the default value for the property.
java.lang.String	getDisplayName() Gets the display name for the property.
java.util.List	getDomainValues(PropertyOwner owner) Returns a list of the raw property domain values.
java.lang.String	getFullName()
java.lang.Integer	getMaxLength() Gets maximum allowed length of values of this property.
java.lang.String	getName() Gets the name of the property definition owner, to be used when creating the NLS key for each property definition.
IRoot	getOwner() Gets the mapping owner (or parent) of this object.
java.lang.String	getOwnerClassName() Gets the owner class name of the property to be created.
IPropertyDefinitionOwner	getPropertyDefinitionOwner() Gets the owner of this property definition.
java.lang.String	getPropertyDisplayNameKey() Gets the property NLS display name key for the property.
java.lang.String	getPropertyName() Gets the property name for the property.
PropertyDefinition.PropertyType	getPropertyType() Gets the property type of the property.
static PropertyDefinition.PropertyType	getPropertyType(java.lang.String type) Gets the PropertyType enum value corresponding to a property type string.
static java.lang.String	getPropertyTypeString(PropertyDefinition.PropertyType type) Gets the String representation for PropertyType enum value.
java.lang.String	getTranslatedDomainValue(java.lang.String value) Gets the NLS translated domain value for a domain value key.
java.lang.String	getValueDisplayType() Gets the value type for display.
boolean	isDynamicDomainValue() Checks if the domain values of this property are dynamically calculated.
boolean	isPersistentProperty() Gets the value of the property persistentProperty.
boolean	isReadOnly() Checks if this property definition is read-only
boolean	valueIsCollection() Returns true if the expected value for the property is a Collection object.
boolean	valueIsList() Returns true if the expected value for the property is a List object.

Methods inherited from class java.lang.Object

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

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

dump, dump, getDisplayableObjectName, getGUID, getStrongTypeClassName, validate, 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.

Method Detail

getPropertyDefinitionOwner

public IPropertyDefinitionOwner getPropertyDefinitionOwner()

Gets the owner of this property definition.

Specified by:

getPropertyDefinitionOwner in interface IMappingObject

Returns:

the owner of this property definition.

getPropertyType

public static PropertyDefinition.PropertyType getPropertyType(java.lang.String type)
                                                       throws MapComponentException

Gets the PropertyType enum value corresponding to a property type string.

Parameters:

type - the string property type name.

Returns:

the PropertyType enum value.

Throws:

MapComponentException

getPropertyTypeString

public static java.lang.String getPropertyTypeString(PropertyDefinition.PropertyType type)

Gets the String representation for PropertyType enum value.

Parameters:

type - the PropertyType enum value.

Returns:

the String representation for the enum value.

getPropertyName

public java.lang.String getPropertyName()

Gets the property name for the property.

Returns:

the name for the property.

getName

public java.lang.String getName()

Description copied from interface: IPropertyDefinitionOwner

Gets the name of the property definition owner, to be used when creating the NLS key for each property definition.

Specified by:

getName in interface IPropertyDefinitionOwner

Specified by:

getName in interface IRoot

Returns:

the name of property definition owner.

getFullName

public java.lang.String getFullName()

getPropertyDisplayNameKey

public java.lang.String getPropertyDisplayNameKey()

Gets the property NLS display name key for the property.

Returns:

the NLS key for the display name.

getDisplayName

public java.lang.String getDisplayName()

Gets the display name for the property.

Returns:

display name of the property.

valueIsList

public boolean valueIsList()

Returns true if the expected value for the property is a List object.

Returns:

true if value of the property is a list, false otherwise.

valueIsCollection

public boolean valueIsCollection()

Returns true if the expected value for the property is a Collection object.

Returns:

true if the value of the property is a collection object, false otherwise.

getDefaultValue

public java.lang.String getDefaultValue()

Gets the default value for the property.

Returns:

the default value of the property.

getPropertyType

public PropertyDefinition.PropertyType getPropertyType()

Gets the property type of the property.

Returns:

the property type.

getOwnerClassName

public java.lang.String getOwnerClassName()

Gets the owner class name of the property to be created.

Returns:

the owner class name.

isPersistentProperty

public boolean isPersistentProperty()

Gets the value of the property persistentProperty.

getChildDef

public PropertyDefinition getChildDef(int index)
                               throws PropertyException

Gets the child property definition at the specified index.

Parameters:

index - the index at which the child property defintion is to be returned.

Returns:

the required child property definition.

Throws:

PropertyException

getChildDefs

public java.util.List getChildDefs()

Gets a list of all child property definitions owned by this property definition.

Returns:

child property definitions.

Throws:

PropertyException

getDomainValues

public java.util.List getDomainValues(PropertyOwner owner)

Returns a list of the raw property domain values. Only valid if the property has a predefined list of legal values, if not return null.

Parameters:

owner - the owner of this property.

Returns:

a list of Strings representing the domain values of this property.

Throws:

PropertyException

getTranslatedDomainValue

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

Gets the NLS translated domain value for a domain value key.

Parameters:

value - the domain value key for which the NLS translation is to be calculated.

Returns:

the translated domain value.

getValueDisplayType

public java.lang.String getValueDisplayType()

Gets the value type for display.

Returns:

the value display type.

isReadOnly

public boolean isReadOnly()

Checks if this property definition is read-only

Returns:

true if this is read-only, false otherwise.

getOwner

public IRoot getOwner()

Description copied from interface: IRoot

Gets the mapping owner (or parent) of this object. Some objects may have an external adapter owner and would return null from this method - for example the mapping object is owned by an adapter container (e.g. OdiFolder) object, which is not an instance of IRoot, so null would be returned.

Specified by:

getOwner in interface IRoot

Returns:

The owner class instance.

findPropertyDefinition

public PropertyDefinition findPropertyDefinition(java.lang.String ownerClass,
                                                 java.lang.String name)

Description copied from interface: IPropertyDefinitionOwner

Finds the property definition with the specified name, or null if not found.

Specified by:

findPropertyDefinition in interface IPropertyDefinitionOwner

Parameters:

ownerClass - the owner class name.

name - the name of the property the property definition defines.

Returns:

a property definition or null if not found.

getMaxLength

public java.lang.Integer getMaxLength()

Gets maximum allowed length of values of this property.

Returns:

Maximum value length of this property.

isDynamicDomainValue

public boolean isDynamicDomainValue()

Checks if the domain values of this property are dynamically calculated.

Returns:

true if domain values are dynamically calculated, false, otherwise.