com.informatica.powercenter.sdk.mapfwk.core
Class Folder

java.lang.Object
  extended by com.informatica.powercenter.sdk.mapfwk.core.Folder

public class Folder
extends java.lang.Object

Represents a folder in the repository.

Note that this class represents a physical folder in the repository as well as folder element in the exported

While creating mappings using JMF, a Folder should be created and added in Repository using Repository.addFolder(Folder) function

Folder objects can be fetched from Repository by using Repository.getFolder() function

Following is sample code for creating folder element in the exported XML while creating mapping objects using JMF

      // create repository element in exported XML 
      Repository repo = new Repository( "TestRepo", "TestRepo", "This is test repo" );
      // create a folder
      Folder    folder = new Folder( "JMF", "JMF", "Test folder" );
      // add a folder element under repository element in exported XML
      repo.addFolder( folder );
      // add mapping and other objects in the folder...
        

See Also:
Repository.addFolder(Folder), Repository.getFolder(), Repository.getFolder(NameFilter), Repository.removeFolder(Folder), RepositoryConnectionManager.listFolders(), RepositoryConnectionManager.listFolders(NameFilter)

Constructor Summary
Folder()
          Default constructor
Folder(java.lang.String name, java.lang.String busName, java.lang.String desc)
          Initialize with name, business name and description
 
Method Summary
 void addMapping(Mapping mapObj)
          Adds a Mapping in the folder if it is not already present
 void addMapping(java.util.Vector vMapObjs)
          Adds a vector of Mapping objects.
 void addMapplet(Mapplet mapObj)
          Adds a Mapplet in the folder if it is not already present
 void addMapplet(java.util.Vector vMapObjs)
          Adds a vector of Mapplet objects.
 void addShortCut(ShortCut scObj)
          Adds a ShortCut in the folder if it is not already present
 void addShortCuts(java.util.Vector vScObjs)
          Adds a vector of ShortCut objects.
 void addSource(Source sourceObj)
          Adds a Source in the folder if it is not already present.
 void addSource(java.util.Vector vSourceObjs)
          Adds a vector of Source objects.
 void addTarget(Target targetObj)
          Adds a Target in the folder if it is not already present
 void addTarget(java.util.Vector vtargetObjs)
          Adds a vector of Target objects.
 void addTransformation(Transformation transObj)
          Adds a Transformation in the folder if it is not already present
 void addTransformation(java.util.Vector vTransObjs)
          Adds a vector of Transformation objects.
 void addWorkFlow(java.util.Vector vobjWorkflows)
          Adds a vector of Workflow objects.
 void addWorkFlow(Workflow objWorkFlow)
          Adds a Workflow in the folder if it is not already present
 boolean equals(java.lang.Object obj)
          Overrides equals method to compare the Folder objects based on Name
 java.lang.String getBusinessName()
          Gets the business name of the folder
 java.lang.String getDescription()
          Gets the description of the folder
 java.util.Vector getMappings()
          Gets the Vector of Mapping objects from the repository.
 java.util.Vector getMappings(NameFilter objFilter)
          Gets the Vector of Mapping objects from the repository.
 java.util.Vector getMapplets()
          Gets the Vector of Mapplet objects from the repository
 java.util.Vector getMapplets(NameFilter objFilter)
          Gets the Vector of Mapplet objects from the repository Filter the Transformation objects using specified filter
 java.lang.String getName()
          Gets the name of the folder
 java.util.Vector getShortCuts(NameFilter objFilter)
          Gets the Vector of Mapplet objects from the repository Filter the Transformation objects using specified filter
 java.util.Vector getSource()
          Gets Vector of Source objects
 java.util.Vector getSource(NameFilter objFilter)
          Gets the Vector of Source objects from the repository.
 Source getSource(java.lang.String name)
          Gets a Source object for a given name
 java.util.Vector getSourceNames()
          Gets the name of sources present in this folder
 java.util.Vector getTarget()
          Gets Vector of Source objects
 java.util.Vector getTarget(NameFilter objFilter)
          Gets the Vector of Target objects from the repository.
 Target getTarget(java.lang.String name)
          Gets a Target object for a given name
 java.util.Vector getTargetNames()
          Gets the name of targets present in this folder
 java.util.Vector getTransformations()
          Gets the Vector of Transformation objects from the repository.
 java.util.Vector getTransformations(int subType)
          Gets the Vector of Transformation objects from the repository for the specified Transformation sub type
 java.util.Vector getTransformations(int subType, NameFilter objFilter)
          Gets the Vector of Transformation objects from the repository for the specified Transformation sub type.
 java.util.Vector getTransformations(NameFilter objFilter)
          Gets the Vector of Transformation objects from the repository Filter the Transformation objects using specified filter
 java.util.Vector getWorkFlows()
          Gets the Vector of Workflow objects from the repository.
 java.util.Vector getWorkFlows(NameFilter objFilter)
          Gets the Vector of Workflow objects from the repository.
 int hashCode()
          Overrides hashCode method as per logic of equals method
 void removeMapping(Mapping mapObj)
          Removes the specified Mapping from the folder
 void removeMapplet(Mapplet mapObj)
          Removes the specified Mapplet from the folder
 void removeShortCut(ShortCut scObj)
          Removes the specified ShortCut from the folder
 void removeSource(Source sourceObj)
          Removes the specified Source from the folder
 void removeTarget(Target targetObj)
          Remove the specified Target from the folder
 void removeTransformation(Transformation transObj)
          Removes the specified Transformation from the folder
 void removeWorkflow(Workflow objWorkflow)
          Remove the specified Workflow from the folder
 void setBusinessName(java.lang.String businessName)
          Sets the business name of the folder
 void setDescription(java.lang.String desc)
          Sets the description of the folder
 void setName(java.lang.String name)
          Sets the name of the folder
 void setRepositoryConnectionManager(RepositoryConnectionManager mgr)
          Sets repository connection manager
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Folder

public Folder()
Default constructor


Folder

public Folder(java.lang.String name,
              java.lang.String busName,
              java.lang.String desc)
Initialize with name, business name and description

Parameters:
name - folder name
busName - folder business name
desc - folder description
Method Detail

getBusinessName

public java.lang.String getBusinessName()
Gets the business name of the folder

Returns:
business name of the folder

setBusinessName

public void setBusinessName(java.lang.String businessName)
Sets the business name of the folder

Parameters:
businessName - business name of the folder

getDescription

public java.lang.String getDescription()
Gets the description of the folder

Returns:
description of the folder

setDescription

public void setDescription(java.lang.String desc)
Sets the description of the folder

Parameters:
desc - description of the folder

getName

public java.lang.String getName()
Gets the name of the folder

Returns:
name of the folder

setName

public void setName(java.lang.String name)
Sets the name of the folder

Parameters:
name - folder name

addSource

public void addSource(Source sourceObj)
Adds a Source in the folder if it is not already present.

Parameters:
sourceObj - Source object

addSource

public void addSource(java.util.Vector vSourceObjs)
Adds a vector of Source objects. Ignore the Source objects
which are already present in the folder

Parameters:
vSourceObjs - Vector of Source objects

removeSource

public void removeSource(Source sourceObj)
Removes the specified Source from the folder

Parameters:
sourceObj - Source object to be removed

addTarget

public void addTarget(Target targetObj)
Adds a Target in the folder if it is not already present

Parameters:
targetObj - target object

addTarget

public void addTarget(java.util.Vector vtargetObjs)
Adds a vector of Target objects. Ignore the Target objects
which are already present in the folder

Parameters:
vtargetObjs - Vector containing Target objects

removeTarget

public void removeTarget(Target targetObj)
Remove the specified Target from the folder

Parameters:
targetObj - Target object to be removed

addTransformation

public void addTransformation(Transformation transObj)
Adds a Transformation in the folder if it is not already present

Parameters:
transObj - Transformation object

addTransformation

public void addTransformation(java.util.Vector vTransObjs)
Adds a vector of Transformation objects. Ignore the Transformation objects
which are already present in the folder

Parameters:
vTransObjs - Vector containing Transformation objects

removeTransformation

public void removeTransformation(Transformation transObj)
Removes the specified Transformation from the folder

Parameters:
transObj - Transformation object

addMapping

public void addMapping(Mapping mapObj)
Adds a Mapping in the folder if it is not already present

Parameters:
mapObj - mapping object
See Also:
getMappings(), Mapping

addMapping

public void addMapping(java.util.Vector vMapObjs)
Adds a vector of Mapping objects. Ignore the Mapping objects
which are already present in the folder

Parameters:
vMapObjs - Vector of Mapping objects
See Also:
addMapping(Mapping), Mapping

removeMapping

public void removeMapping(Mapping mapObj)
Removes the specified Mapping from the folder

Parameters:
mapObj - mapping object

getSource

public Source getSource(java.lang.String name)
Gets a Source object for a given name

Parameters:
name - name of the Source
Returns:
Source object
See Also:
getSource(NameFilter), getSource(), Source

getSource

public java.util.Vector getSource(NameFilter objFilter)
                           throws com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException,
                                  com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException,
                                  com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException
Gets the Vector of Source objects from the repository.
Filter the Source objects using specified filter

Parameters:
objFilter - name filter to filter the Source objects
Returns:
Vector of Source objects
Throws:
com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException - If connection to repository if failed
com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException - If folder is not found in repository
com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException - If some error occurs while fetching the Source object
See Also:
getSource(), getSource(String), Source

getTarget

public Target getTarget(java.lang.String name)
Gets a Target object for a given name

Parameters:
name - name of the Target
Returns:
Target object
See Also:
getTarget(NameFilter), getTarget(String), Target

getSource

public java.util.Vector getSource()
Gets Vector of Source objects

Returns:
Vector of Source objects
See Also:
getSource(NameFilter), getSource(String), Source

getSourceNames

public java.util.Vector getSourceNames()
Gets the name of sources present in this folder

Returns:
Vector containing name of sources present in this folder
See Also:
getSource(), getSource(NameFilter), getSource(String), getTargetNames()

getTarget

public java.util.Vector getTarget()
Gets Vector of Source objects

Returns:
Vector of Target Object
See Also:
getTarget(NameFilter), getTarget(String), Target

getTarget

public java.util.Vector getTarget(NameFilter objFilter)
                           throws com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException,
                                  com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException,
                                  com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException
Gets the Vector of Target objects from the repository.
Filter the Target objects using specified filter

Parameters:
objFilter - name filter to filter the Target objects
Returns:
Vector of Target objects
Throws:
com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException - If connection to repository if failed
com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException - If folder is not found in repository
com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException - If some error occurs while fetching the Target object
See Also:
getTarget(), getTarget(String), Target

getTargetNames

public java.util.Vector getTargetNames()
Gets the name of targets present in this folder

Returns:
Vector containing name of targets present in this folder
See Also:
getTarget(), getTarget(String), getTarget(NameFilter), getSourceNames()

getMappings

public java.util.Vector getMappings()
Gets the Vector of Mapping objects from the repository.

Returns:
Vector of Mapping object
See Also:
getMappings(NameFilter), Mapping

getMappings

public java.util.Vector getMappings(NameFilter objFilter)
                             throws com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException,
                                    com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException,
                                    com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException
Gets the Vector of Mapping objects from the repository.
Filter the Mapping objects using specified filter

Parameters:
objFilter - name filter to filter the Mapping objects
Returns:
Vector of Target objects
Throws:
com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException - If connection to repository if failed
com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException - If folder is not found in repository
com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException - If some error occurs while fetching the Mapping object
See Also:
getMappings(), Mapping

getWorkFlows

public java.util.Vector getWorkFlows()
Gets the Vector of Workflow objects from the repository.

Returns:
Vector of Workflow objects
See Also:
Workflow, getWorkFlows(NameFilter)

getWorkFlows

public java.util.Vector getWorkFlows(NameFilter objFilter)
                              throws com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException,
                                     com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException,
                                     com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException
Gets the Vector of Workflow objects from the repository.
Filter the Workflow objects using specified filter

Parameters:
objFilter - name filter to filter the Workflow objects
Returns:
Vector of Target objects
Throws:
com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException - If connection to repository if failed
com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException - If folder is not found in repository
com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException - If some error occurs while fetching the Workflow object
See Also:
getMappings(), Workflow

getTransformations

public java.util.Vector getTransformations()
Gets the Vector of Transformation objects from the repository.

Returns:
Vector of Transformation objects
See Also:
getTransformations(NameFilter), getTransformations(int), getTransformations(int, NameFilter), Transformation

getTransformations

public java.util.Vector getTransformations(int subType)
                                    throws com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException,
                                           com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException,
                                           com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException
Gets the Vector of Transformation objects from the repository for the specified Transformation sub type

Parameters:
subType - Transformation sub type
Returns:
Vector of Transformation objects
Throws:
com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException - If connection to repository if failed
com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException - If folder is not found in repository
com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException - If some error occurs while fetching the Transformation objects
See Also:
getTransformations(NameFilter), getTransformations(), getTransformations(int, NameFilter), Transformation

getTransformations

public java.util.Vector getTransformations(NameFilter objFilter)
                                    throws com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException,
                                           com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException,
                                           com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException
Gets the Vector of Transformation objects from the repository Filter the Transformation objects using specified filter

Parameters:
subType - Transformation sub type
Returns:
Vector of Transformation objects
Throws:
com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException - If connection to repository if failed
com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException - If folder is not found in repository
com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException - If some error occurs while fetching the Transformation objects
See Also:
getTransformations(NameFilter), getTransformations(int), getTransformations(int, NameFilter), Transformation

getTransformations

public java.util.Vector getTransformations(int subType,
                                           NameFilter objFilter)
                                    throws com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException,
                                           com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException,
                                           com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException
Gets the Vector of Transformation objects from the repository for the specified Transformation sub type. Filter the Transformation objects using specified filter

Parameters:
subType - Transformation sub type
Returns:
Vector of Transformation objects
Throws:
com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException - If connection to repository if failed
com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException - If folder is not found in repository
com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException - If some error occurs while fetching the Transformation objects
See Also:
getTransformations(NameFilter), getTransformations(int), getTransformations(), Transformation

addWorkFlow

public void addWorkFlow(Workflow objWorkFlow)
Adds a Workflow in the folder if it is not already present

Parameters:
objWorkFlow - Workflow object

addWorkFlow

public void addWorkFlow(java.util.Vector vobjWorkflows)
Adds a vector of Workflow objects. Ignore the Workflow objects
which are already present in the folder

Parameters:
vobjWorkflows - Vector containing Workflow objects

removeWorkflow

public void removeWorkflow(Workflow objWorkflow)
Remove the specified Workflow from the folder

Parameters:
objWorkflow - Workflow object to be removed

setRepositoryConnectionManager

public void setRepositoryConnectionManager(RepositoryConnectionManager mgr)
Sets repository connection manager

Parameters:
mgr - repository connection manager
See Also:
RepositoryConnectionManager

getMapplets

public java.util.Vector getMapplets()
                             throws com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException,
                                    com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException,
                                    com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException
Gets the Vector of Mapplet objects from the repository

Returns:
Vector of Mapplet objects
Throws:
com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException - If connection to repository if failed
com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException - If folder is not found in repository
com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException - If some error occurs while fetching the Mapplet objects
See Also:
getMapplets(NameFilter), Mapplet

getMapplets

public java.util.Vector getMapplets(NameFilter objFilter)
                             throws com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException,
                                    com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException,
                                    com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException
Gets the Vector of Mapplet objects from the repository Filter the Transformation objects using specified filter

Parameters:
objFilter - filter for Transformation object
Returns:
Vector of Mapplet objects
Throws:
com.informatica.powercenter.sdk.mapfwk.exceptions.ConnectionFailedException - If connection to repository if failed
com.informatica.powercenter.sdk.mapfwk.exceptions.FolderNotFoundException - If folder is not found in repository
com.informatica.powercenter.sdk.mapfwk.exceptions.ObjectFetchFailedException - If some error occurs while fetching the Mapplet objects
See Also:
getMapplets(), Mapplet

hashCode

public int hashCode()
Overrides hashCode method as per logic of equals method

Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides equals method to compare the Folder objects based on Name

Overrides:
equals in class java.lang.Object

addMapplet

public void addMapplet(Mapplet mapObj)
Adds a Mapplet in the folder if it is not already present

Parameters:
mapObj - Mapplet object
See Also:
addMapplet(Vector)

addMapplet

public void addMapplet(java.util.Vector vMapObjs)
Adds a vector of Mapplet objects. Ignore the Mapplet objects
which are already present in the folder

Parameters:
vMapObjs - Vector of Mapplet objects
See Also:
addMapplet(Mapplet)

removeMapplet

public void removeMapplet(Mapplet mapObj)
Removes the specified Mapplet from the folder

Parameters:
mapObj - Mapplet object to be removed

addShortCut

public void addShortCut(ShortCut scObj)
Adds a ShortCut in the folder if it is not already present

Parameters:
scObj - ShortCut object
See Also:
addShortCuts(Vector)

addShortCuts

public void addShortCuts(java.util.Vector vScObjs)
Adds a vector of ShortCut objects. Ignore the ShortCut objects
which are already present in the folder

Parameters:
vScObjs - Vector of ShortCut objects
See Also:
addShortCut(ShortCut)

removeShortCut

public void removeShortCut(ShortCut scObj)
Removes the specified ShortCut from the folder

Parameters:
scObj - ShortCut object to be removed

getShortCuts

public java.util.Vector getShortCuts(NameFilter objFilter)
Gets the Vector of Mapplet objects from the repository Filter the Transformation objects using specified filter

Parameters:
objFilter - filter for Mapplet object
Returns:
Vector of Mapplet objects