oracle.odi.domain.root

Interface IPropertyOwner

All Superinterfaces:

IMappingObject, INamedObject, IRepositoryEntity, IRoot

All Known Subinterfaces:

IMapComponent, IMapComponentOwner, IMapRootContainer, IMapSignatureOwner, IMapSignatureOwnerHolder, oracle.odi.domain.mapping.component.IReusableMappingHolder

All Known Implementing Classes:

AggregateComponent, CubeComponent, Dataset, DataStorageDelegate, DatastoreComponent, DefaultDelegate, DeploymentSpec, DimensionComponent, DistinctComponent, ExecutionUnit, ExecutionUnitGroup, ExpandableComponentDelegate, ExpressionComponent, oracle.odi.domain.mapping.FCOMapComponentOwner, FileComponent, FilterComponent, FlattenComponent, InputConnectorPoint, InputSignature, JaggedComponent, JoinComponent, LookupComponent, MapAttribute, oracle.odi.domain.mapping.MapComponentDelegate, oracle.odi.domain.mapping.MapComponentDelegator, oracle.odi.domain.mapping.MapComponentOwner, MapConnectorPoint, MapPhysicalDesign, MapPhysicalNode, Mapping, oracle.odi.domain.mapping.MapRootContainer, MapSignatureOwnerComponentDelegate, OutputConnectorPoint, OutputSignature, PivotComponent, Property, oracle.odi.domain.root.PropertyOwner, ReusableMapping, ReusableMappingComponent, SetComponent, SignatureComponentDelegate, SorterComponent, SplitterComponent, SubqueryFilterComponent, TableFunctionComponent, UnpivotComponent

public interface IPropertyOwner
extends INamedObject

An interface that represents any mapping object that can own properties. A property is a name/value pair, where the value can be a string, expression, or reference object.

Method Summary

Modifier and Type	Method and Description
void	addProperty(Property newProp) Add a named property to this object.
Property	createProperty(PropertyDefinition propDef) Create a property and add it to this object, using a property definition object.
java.util.List	getAllProperties() Get a list of all properties owned by this object, also all sub-properties owned by those properties, if any.
boolean	getBooleanPropertyValue(java.lang.String key) A helper method to get the value of the property with the specified key name, and convert the value to a boolean value if possible.
java.util.List	getDisplayableProperties() Get a list of properties that are not marked as hidden, and thus will be displayed in the UI or console.
java.lang.String	getDisplayableTypeName() Get a displayable type name for the property owner object.
MapExpression	getExpressionPropertyValue(java.lang.String key) Gets a property value as an expression.
java.lang.Integer	getIntPropertyValue(java.lang.String key) A helper method to get the value of the property with the specified key name, and convert the value to an integer value if possible.
java.util.List	getProperties() Get a list of all properties owned by this object.
Property	getProperty(java.lang.String key) Get the property object with the specified name.
java.lang.Object	getPropertyValue(java.lang.String key) Get the value of the property with the specified key name.
java.lang.String	getStringPropertyValue(java.lang.String key) Get the property value as a string.
boolean	isPropertyDefined(java.lang.String key) Return true if this property owner has a property with the specified key name, else false.
void	setBooleanPropertyValue(java.lang.String key, boolean value) A helper method to set the value of the property with the specified key name, and convert the specified value from a boolean to the actual persisted type if possible.
void	setIntPropertyValue(java.lang.String key, int value) A helper method to set the value of the property with the specified key name, and convert the specified value from an integer to the actual persisted type if possible.
void	setPropertyValue(java.lang.String key, java.lang.Object value) Set a property value for the property with the specified key name.

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

getBusinessName, getDescription, getName, setBusinessName, setDescription, setName

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

dump, dump, getDisplayableObjectName, getGUID, getOwner, 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

Method Detail

getProperties

java.util.List getProperties()

Get a list of all properties owned by this object.

getDisplayableProperties

java.util.List getDisplayableProperties()

Get a list of properties that are not marked as hidden, and thus will be displayed in the UI or console.

getAllProperties

java.util.List getAllProperties()

Get a list of all properties owned by this object, also all sub-properties owned by those properties, if any.

getPropertyValue

java.lang.Object getPropertyValue(java.lang.String key)
                           throws PropertyException

Get the value of the property with the specified key name.

Parameters:

key - The name of the property whose value to fetch.

Returns:

The property value object. The type of the value object will be determined by the type of the property.

Throws:

PropertyException

setPropertyValue

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

Set a property value for the property with the specified key name.

Parameters:

key - The name of the property whose value will be set.

value - The object value of the property. The interpretation of the object type will be determined by the type of the property.

Throws:

PropertyException

getBooleanPropertyValue

boolean getBooleanPropertyValue(java.lang.String key)
                         throws PropertyException

A helper method to get the value of the property with the specified key name, and convert the value to a boolean value if possible.

Parameters:

key - The name of the property.

Returns:

The boolean value of the property.

Throws:

PropertyException

getIntPropertyValue

java.lang.Integer getIntPropertyValue(java.lang.String key)
                               throws PropertyException

A helper method to get the value of the property with the specified key name, and convert the value to an integer value if possible. Return null if the property has not been assigned a value or value is not a valid integer

Parameters:

key - The name of the property.

Returns:

The int value of the property.

Throws:

{@link - PropertyException} will be thrown out if no such property with the specified key name defined.

PropertyException

setIntPropertyValue

void setIntPropertyValue(java.lang.String key,
                         int value)
                  throws PropertyException

A helper method to set the value of the property with the specified key name, and convert the specified value from an integer to the actual persisted type if possible. An exception will be thrown if the passed-in value cannot be converted from an integer to the correct persisted type (e.g. String).

Parameters:

key - The name of the property.

value - The int value to which to set the property value.

Throws:

PropertyException

getExpressionPropertyValue

MapExpression getExpressionPropertyValue(java.lang.String key)
                                  throws PropertyException

Gets a property value as an expression. An exception is thrown if the property does not exist or if it is not an expression property type.

Parameters:

key -

Throws:

PropertyException

setBooleanPropertyValue

void setBooleanPropertyValue(java.lang.String key,
                             boolean value)
                      throws PropertyException

A helper method to set the value of the property with the specified key name, and convert the specified value from a boolean to the actual persisted type if possible. An exception will be thrown if the passed-in value cannot be converted from a boolean to the correct persisted type (e.g. String).

Parameters:

key - The name of the property.

value - The boolean value to which to set the property value.

Throws:

PropertyException

getProperty

Property getProperty(java.lang.String key)
              throws PropertyException

Get the property object with the specified name.

Parameters:

key - The key name of the property to be fetched.

Returns:

The property object, from which the value can be obtained.

Throws:

PropertyException

isPropertyDefined

boolean isPropertyDefined(java.lang.String key)
                   throws PropertyException

Return true if this property owner has a property with the specified key name, else false.

Parameters:

key - The key name to check.

Throws:

PropertyException

addProperty

void addProperty(Property newProp)
          throws PropertyException

Add a named property to this object. After adding the property, it's value will be accessible by name.

Parameters:

newProp - The property object to add to this object.

Throws:

PropertyException

createProperty

Property createProperty(PropertyDefinition propDef)
                 throws MappingException

Create a property and add it to this object, using a property definition object.

Parameters:

propDef - The property definition object.

Returns:

The newly created property object.

Throws:

PropertyException

MappingException

See Also:

PropertyDefinition

getDisplayableTypeName

java.lang.String getDisplayableTypeName()

Get a displayable type name for the property owner object.

Specified by:

getDisplayableTypeName in interface IRoot

Returns:

The displayable type name.

getStringPropertyValue

java.lang.String getStringPropertyValue(java.lang.String key)
                                 throws PropertyException

Get the property value as a string.

Throws:

PropertyException