oracle.odi.domain.root

Interface IRoot

All Superinterfaces:

IMappingObject, IRepositoryEntity

All Known Subinterfaces:

IFCORoot, IMapComponent, IMapComponentOwner, IMapExpressionOwner, IMapRootContainer, INamedObject, IPropertyDefinitionOwner, IPropertyOwner

All Known Implementing Classes:

AggregateComponent, Dataset, DataStorageDelegate, DatastoreComponent, DatastoreOverridenConstraint, DefaultDelegate, DeploymentSpec, DistinctComponent, ExecutionUnit, ExecutionUnitGroup, ExpressionComponent, oracle.odi.domain.mapping.FCOMapComponentOwner, oracle.odi.domain.root.FCONamedObject, oracle.odi.domain.root.FCORoot, FileComponent, FilterComponent, FlattenComponent, InputConnectorPoint, InputSignature, JoinComponent, LookupComponent, MapAttribute, MapComponent, oracle.odi.domain.mapping.MapComponentDelegate, oracle.odi.domain.mapping.MapComponentDelegator, MapComponentOwner, MapComponentType, MapConnector, MapConnectorPoint, MapConnectorPointRole, MapExpression, MapExpressionXRef, MapPhysicalColumn, MapPhysicalDesign, MapPhysicalExpression, MapPhysicalNode, Mapping, MappingDataType, MappingGenericTechnology, MapReference, MapRootContainer, oracle.odi.domain.root.NamedObject, OutputConnectorPoint, OutputSignature, PivotComponent, Property, PropertyDefinition, oracle.odi.domain.root.PropertyOwner, ReusableMapping, ReusableMappingComponent, oracle.odi.domain.root.Root, SetComponent, SorterComponent, SplitterComponent, SubqueryFilterComponent, TableFunctionComponent, UnpivotComponent

public interface IRoot
extends IMappingObject, IRepositoryEntity

An interface to represent a mapping object.

Method Summary

Methods

Modifier and Type	Method and Description
void	dump() Dump metadata and state information about this object to the system output stream.
void	dump(java.io.OutputStream ostream) Dump metadata and state information about this object to the specified output stream.
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	getGUID() Get the unique object GUID for this object.
java.lang.String	getName() Get the name for this object.
IRoot	getOwner() Gets the mapping owner (or parent) of this object.
java.lang.String	getStrongTypeClassName() Get the strongly typed class name for this object.
boolean	validate() Validates the object, and adds all error, warning, or informational issues that are found by validation to the transient issue cache.
boolean	validate(java.util.List result, boolean debug) Validates the object, and adds all error, warning, or informational issues that are found by validation to the specified issue list.
boolean	validate(java.util.List result, boolean debug, Mapping topLevelMapping) Validates the object, and adds all error, warning, or informational issues that are found by validation to the specified issue list.

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

getRootContainer

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getInternalId, getSecurityContainer

Method Detail

getOwner

IRoot getOwner()

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.

Returns:

The owner class instance.

getName

java.lang.String getName()

Get the name for this object.

getStrongTypeClassName

java.lang.String getStrongTypeClassName()

Get the strongly typed class name for this object.

getGUID

java.lang.String getGUID()

Get the unique object GUID for this object.

validate

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

Validates the object, and adds all error, warning, or informational issues that are found by validation to the specified issue list.

Parameters:

result - A list of issues that were found by 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.

validate

boolean validate(java.util.List result,
               boolean debug,
               Mapping topLevelMapping)

Validates the object, and adds all error, warning, or informational issues that are found by validation to the specified issue list.

Parameters:

result - A list of issues that were found by validation.

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

topLevelMapping - The top-level mapping that is being validated.

Returns:

true if any errors were found, else false.

validate

boolean validate()

Validates the object, and adds all error, warning, or informational issues that are found by validation to the transient issue cache.

Returns:

true if any errors were found, else false.

dump

void dump()

Dump metadata and state information about this object to the system output stream.

dump

void dump(java.io.OutputStream ostream)

Dump metadata and state information about this object to the specified output stream.

getDisplayableTypeName

java.lang.String getDisplayableTypeName()

Get a user-displayable type name for the object.

getDisplayableObjectName

java.lang.String getDisplayableObjectName()

Return a user-displayable name for this object.