oracle.odi.domain.project

Class OdiFolder

java.lang.Object

AbstractOdiEntity

oracle.odi.domain.project.OdiFolder

All Implemented Interfaces:

IContainer, IModelObject, IModelObjectBase, IFolder, IImportRoot, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity, IOdiScenarioSourceContainer

public class OdiFolder
extends AbstractOdiEntity
implements IFolder, IOdiScenarioSourceContainer, IWorkDevelopmentOdiEntity, IImportRoot

An OdiFolder is a workbench entity that ODI users will use to organize their work related to a single OdiProject.

Since:

11.1.1.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OdiFolder.ReleaseTag

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAME_MAX_LENGTH Maximum name length allowed.

Constructor Summary

Constructors

Constructor and Description
OdiFolder(OdiFolder pParentFolder, java.lang.String pName) Constructor who sets parent folder and the name of the folder.
OdiFolder(OdiProject pProject, java.lang.String pName) Constructor who sets the parent project and the name of the folder.

Method Summary

Modifier and Type	Method and Description
void	addInterface(OdiInterface pInterface) Add the given OdiInterface to the collection of OdiInterfaces.
void	addMapping(Mapping pMapping) Add the given Mapping to the collection of Mappings.
void	addPackage(OdiPackage pPackage) Add the given OdiPackage to the collection of OdiPackages.
void	addReusableMapping(ReusableMapping pReusableMapping) Adds a reusable mapping to this folder.
void	addSubFolder(OdiFolder pSubFolder) Add the given OdiFolder to the collection of OdiFolders.
void	addUserProcedure(OdiUserProcedure pUserProcedure) Add the given OdiUserProcedure to the collection of OdiUserProcedures.
Mapping	findMapping(java.lang.String name) Deprecated. use IMappingFinder.findByName(IFolder folder, String pName).
ReusableMapping	findReusableMapping(java.lang.String name) Finds a reusable mapping in this folder, given a mapping name.
java.util.List	getChildren()
java.lang.Number	getFolderId() Returns this OdiFolder instance's identifier.
java.util.Collection	getInterfaces() Obtains the unmodifable collection of OdiInterfaces.
java.io.Serializable	getInternalId() Return this OdiFolder instance's identifier.
java.util.List	getMappings() Gets a list of mappings owned by this folder.
java.lang.String	getName() Returns the name of the OdiFolder.
java.util.Collection	getPackages() Obtains the unmodifiable collection of OdiPackages.
OdiFolder	getParentFolder() Return the parent OdiFolder of this OdiFolder.
OdiProject	getProject() Returns the parent OdiProject that owns this OdiFolder instance.
IReleaseTag	getReleaseTag() Get the IReleaseTag object.
java.util.List	getReusableMappings() Gets a list of reusable mappings owned by this folder.
IRepositoryEntity	getSecurityContainer()
java.util.Collection	getSubFolders() Obtains the unmodifable collection of OdiFolders.
java.util.Collection	getUserProcedures() Obtains the unmodifable collection of OdiUserProcedures.
boolean	isInstanceLevelSecurityNeeded() Internal: this method is for internal purpose and must not be considered as part of the public API.
void	refreshIMapping(IMapping pMapping) Refresh mapping list with given Mapping object.
void	refreshReusableMapping(ReusableMapping pReusableMapping) Refresh reusable mapping list with given ReusableMapping object.
void	removeInterface(OdiInterface pInterface) Remove the given OdiInterface from the collection of OdiInterfaces.
void	removeMapping(Mapping pMapping) Remove the given OdiInterface from the collection of OdiInterfaces.
void	removePackage(OdiPackage pPackage) Remove the given OdiPackage from the collection of OdiPackages.
void	removeReusableMapping(ReusableMapping pReusableMapping) Removes a reusable mapping from this folder.
void	removeSubFolder(OdiFolder pSubFolder) Remove the given OdiFolder from the collection of OdiFolders.
void	removeUserProcedure(OdiUserProcedure pUserProcedure) Remove the given OdiUserProcedure from the collection of OdiUserProcedures.
void	setName(java.lang.String pName) Sets the name of this OdiFolder instance. pName must 400 characters long max. Can't be null or empty.
void	setReleaseTag(IReleaseTag pReleaseTag) Set the IReleaseTag object.
boolean	supportsImport(java.lang.Class pChildClass) Return true if OdiFolder is root for an import of this class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.odi.domain.adapter.IModelObjectBase

getBigNumericId, getGlobalId, getNumericId

Methods inherited from interface oracle.odi.domain.IOdiEntity

getFirstDate, getFirstUser, getLastDate, getLastUser

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Field Detail

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

Maximum name length allowed.

See Also:

Constant Field Values

Constructor Detail

OdiFolder

public OdiFolder(OdiProject pProject,
                 java.lang.String pName)

Constructor who sets the parent project and the name of the folder.

Parameters:

pProject - owning project

pName - folder name

Throws:

DomainRuntimeException - if the project is null ; if the name is null, empty or longer than NAME_MAX_LENGTH

See Also:

OdiProject, NAME_MAX_LENGTH

OdiFolder

public OdiFolder(OdiFolder pParentFolder,
                 java.lang.String pName)

Constructor who sets parent folder and the name of the folder.

Parameters:

pParentFolder - owning folder

pName - folder name

Throws:

DomainRuntimeException - if the parent folder is null ; if the name is null, empty or longer than NAME_MAX_LENGTH

See Also:

NAME_MAX_LENGTH

Method Detail

getUserProcedures

public java.util.Collection getUserProcedures()

Obtains the unmodifable collection of OdiUserProcedures.

Use removeUserProcedure(OdiUserProcedure) and addUserProcedure(OdiUserProcedure) to respectively add and remove OdiUserProcedure.

Returns:

a Collection object representing the user procedures value

See Also:

addUserProcedure(OdiUserProcedure), removeUserProcedure(OdiUserProcedure)

isInstanceLevelSecurityNeeded

public boolean isInstanceLevelSecurityNeeded()

Description copied from interface: IOdiEntity

Internal: this method is for internal purpose and must not be considered as part of the public API.

Defines a method to capture the info on which object needs instance level privilege.

Specified by:

isInstanceLevelSecurityNeeded in interface IOdiEntity

Returns:

true if instance level security needed, false otherwise

addUserProcedure

public void addUserProcedure(OdiUserProcedure pUserProcedure)

Add the given OdiUserProcedure to the collection of OdiUserProcedures.

This will also set the Folder of the given OdiUserProcedure to this OdiFolder instance.

If the given OdiUserProcedure was already associated to an other OdiFolder it will be removed from this one.

Parameters:

pUserProcedure - an OdiUserProcedure object

Throws:

DomainRuntimeException - if pUserProcedure is null. TODO other possible cause of this exception (Self association, Scope...)

removeUserProcedure

public void removeUserProcedure(OdiUserProcedure pUserProcedure)

Remove the given OdiUserProcedure from the collection of OdiUserProcedures.

This will also reset the OdiFolder of the given OdiUserProcedure to null.

Note: you will have to call IOdiEntityManager.remove(pUserProcedure) too in order to really remove the OdiUserProcedure

Parameters:

pUserProcedure - an OdiUserProcedure object

Throws:

DomainRuntimeException - if pUserProcedure is null or does not belong to this OdiFolder

getSubFolders

public java.util.Collection getSubFolders()

Obtains the unmodifable collection of OdiFolders.

Use removeSubFolder(OdiFolder) and addSubFolder(OdiFolder) to respectively add and remove OdiFolder.

Returns:

a Collection object representing the sub folders value

See Also:

addSubFolder(OdiFolder), removeSubFolder(OdiFolder)

addSubFolder

public void addSubFolder(OdiFolder pSubFolder)

Add the given OdiFolder to the collection of OdiFolders.

This will also set the ParentFolder of the given OdiFolder to this OdiFolder instance.

If the given OdiFolder was already associated to an other OdiFolder it will be removed from this one.

Parameters:

pSubFolder - an OdiFolder object

Throws:

DomainRuntimeException - if pSubFolder is null or if you try to define cycle in OdiFolder hierarchy or you try to move an OdiFolder from a Project to an other.

removeSubFolder

public void removeSubFolder(OdiFolder pSubFolder)

Remove the given OdiFolder from the collection of OdiFolders.

This will also reset the OdiFolder of the given OdiFolder to null making the given OdiFolder a root OdiFolder.

Note: You will have to call IOdiEntityManager.remove(pSubFolder) too in order to remove the OdiFolder from the repository

Parameters:

pSubFolder - an OdiFolder object

Throws:

DomainRuntimeException - if pSubFolder is null or does not belong to this OdiFolder

getInterfaces

public java.util.Collection getInterfaces()

Obtains the unmodifable collection of OdiInterfaces.

Use removeInterface(OdiInterface) and addInterface(OdiInterface) to respectively add and remove OdiInterface.

Returns:

a Collection object representing the interfaces value

See Also:

addInterface(OdiInterface), removeInterface(OdiInterface)

getMappings

public java.util.List getMappings()

Description copied from interface: IFolder

Gets a list of mappings owned by this folder.

Specified by:

getMappings in interface IFolder

Returns:

list of owned mappings.

addInterface

public void addInterface(OdiInterface pInterface)

Add the given OdiInterface to the collection of OdiInterfaces.

This will also set the Folder of the given OdiInterface to this OdiFolder instance.

If the given OdiInterface was already associated to an other OdiFolder it will be removed from this one.

Parameters:

pInterface - an OdiInterface object

Throws:

DomainRuntimeException - if pInterface is null. TODO other possible cause of this exception (Self association, Scope...)

removeInterface

public void removeInterface(OdiInterface pInterface)

Remove the given OdiInterface from the collection of OdiInterfaces.

This will also reset the OdiFolder of the given OdiInterface to null.

Note: you will have to call IOdiEntityManager.remove(pInterface) too in order to really remove the OdiInterface

Parameters:

pInterface - an OdiInterface object

Throws:

DomainRuntimeException - if pInterface is null or does not belong to this OdiFolder

addMapping

public void addMapping(Mapping pMapping)

Add the given Mapping to the collection of Mappings.

This will also set the Folder of the given Mapping to this OdiFolder instance.

If the given Mapping was already associated to an other OdiFolder it will be removed from this one.

Specified by:

addMapping in interface IFolder

Parameters:

pMapping - a Mapping object

Throws:

DomainRuntimeException - if pMapping is null. TODO other possible cause of this exception (Self association, Scope...)

removeMapping

public void removeMapping(Mapping pMapping)

Remove the given OdiInterface from the collection of OdiInterfaces.

This will also reset the OdiFolder of the given OdiInterface to null.

Note: you will have to call IOdiEntityManager.remove(pInterface) too in order to really remove the OdiInterface

Specified by:

removeMapping in interface IFolder

Parameters:

pMapping - an OdiInterface object

Throws:

DomainRuntimeException - if pInterface is null or does not belong to this OdiFolder

refreshIMapping

public void refreshIMapping(IMapping pMapping)

Refresh mapping list with given Mapping object.

Parameters:

pMapping -

setName

public void setName(java.lang.String pName)

Sets the name of this OdiFolder instance.
pName must 400 characters long max.
Can't be null or empty.

Parameters:

pName - folder name

Throws:

DomainRuntimeException - if the name is null, empty or longer than NAME_MAX_LENGTH

See Also:

NAME_MAX_LENGTH, getName()

getName

public java.lang.String getName()

Returns the name of the OdiFolder. Can't be null or empty.

Specified by:

getName in interface IModelObject

Specified by:

getName in interface IOdiEntity

Returns:

String

See Also:

setName(String)

getProject

public OdiProject getProject()

Returns the parent OdiProject that owns this OdiFolder instance. Return value can't be null.

Specified by:

getProject in interface IFolder

Returns:

OdiProject

getInternalId

public java.io.Serializable getInternalId()

Return this OdiFolder instance's identifier.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the persistence identity of this instance

See Also:

getFolderId()

getFolderId

public java.lang.Number getFolderId()

Returns this OdiFolder instance's identifier.

Returns:

a Number object representing the folder id value

getPackages

public java.util.Collection getPackages()

Obtains the unmodifiable collection of OdiPackages.

Use removePackage(OdiPackage) and addPackage(OdiPackage) to respectively add and remove OdiPackage.

Returns:

a Collection object representing the packages value

See Also:

addPackage(OdiPackage), removePackage(OdiPackage)

addPackage

public void addPackage(OdiPackage pPackage)

Add the given OdiPackage to the collection of OdiPackages.

This will also set the ParentFolder of the given OdiPackage to this OdiFolder instance.

If the given OdiPackage was already associated to an other OdiFolder it will be removed from this one.

Parameters:

pPackage - an OdiPackage object

Throws:

DomainRuntimeException - if pPackage is null. TODO other possible cause of this exception (Self association, Scope...)

removePackage

public void removePackage(OdiPackage pPackage)

Remove the given OdiPackage from the collection of OdiPackages.

This will also reset the OdiFolder of the given OdiPackage to null.

Note: you will have to call IOdiEntityManager.remove(pPackage) too in order to really remove the OdiPackage

Parameters:

pPackage - an OdiPackage object

Throws:

DomainRuntimeException - if pPackage is null or does not belong to this OdiFolder

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Specified by:

getSecurityContainer in interface IRepositoryEntity

Returns:

container entity

getParentFolder

public OdiFolder getParentFolder()

Return the parent OdiFolder of this OdiFolder. null if this is a root OdiFolder of the OdiProject.

Returns:

an OdiFolder object representing the parent folder value

supportsImport

public boolean supportsImport(java.lang.Class pChildClass)

Return true if OdiFolder is root for an import of this class.

Specified by:

supportsImport in interface IImportRoot

Parameters:

pChildClass - Class to check

Returns:

true if OdiFolder is a parent of pChildClass for import purposes

setReleaseTag

public void setReleaseTag(IReleaseTag pReleaseTag)

Set the IReleaseTag object.

The release tag associated models and folders participating in the same release. IReleaseTag.getValue() == null implies that the release tag is not set.

This will actually set the values of the the release tag. Passing in a null will set the value of this release tag to null.

Parameters:

pReleaseTag -

See Also:

getReleaseTag()

getReleaseTag

public IReleaseTag getReleaseTag()

Get the IReleaseTag object.

The release tag associated models and folders participating in the same release. IReleaseTag.getValue() == null implies that the release tag is not set.

Specified by:

getReleaseTag in interface IFolder

Returns:

IReleaseTag release tag. The release tag will never be null. getValue() may be.

See Also:

setReleaseTag(oracle.odi.domain.IReleaseTag)

getChildren

public java.util.List getChildren()

Specified by:

getChildren in interface IContainer

findMapping

@Deprecated
public Mapping findMapping(java.lang.String name)

Deprecated. use IMappingFinder.findByName(IFolder folder, String pName).

Description copied from interface: IFolder

Finds a mapping owned by this folder, given a mapping name.

Specified by:

findMapping in interface IFolder

Parameters:

name - name of the mapping to find.

Returns:

mapping found in this folder, or null if not found.

getReusableMappings

public java.util.List getReusableMappings()

Description copied from interface: IFolder

Gets a list of reusable mappings owned by this folder.

Specified by:

getReusableMappings in interface IFolder

Returns:

list of owned reusable mappings.

removeReusableMapping

public void removeReusableMapping(ReusableMapping pReusableMapping)

Description copied from interface: IFolder

Removes a reusable mapping from this folder.

Specified by:

removeReusableMapping in interface IFolder

Parameters:

pReusableMapping - reusable mapping to remove.

addReusableMapping

public void addReusableMapping(ReusableMapping pReusableMapping)

Description copied from interface: IFolder

Adds a reusable mapping to this folder.

Specified by:

addReusableMapping in interface IFolder

Parameters:

pReusableMapping - reusable mapping to add to this folder.

refreshReusableMapping

public void refreshReusableMapping(ReusableMapping pReusableMapping)

Refresh reusable mapping list with given ReusableMapping object.

Parameters:

pReusableMapping -

findReusableMapping

public ReusableMapping findReusableMapping(java.lang.String name)

Description copied from interface: IFolder

Finds a reusable mapping in this folder, given a mapping name.

Specified by:

findReusableMapping in interface IFolder

Parameters:

name - name of reusable mapping to find.

Returns:

reusable mapping found in this folder, or null if not found.