oracle.jdeveloper.deploy.dt
Class Profile

java.lang.Object
  oracle.javatools.data.HashStructureAdapter
      oracle.jdeveloper.deploy.dt.DeployElement
          oracle.jdeveloper.deploy.dt.Profile

All Implemented Interfaces:

Displayable, Element, SubDirtyable, Subject, Dirtyable, oracle.jdeveloper.deploy.common.Interdependency, Deployable, LinkedDirtyable

Direct Known Subclasses:

ArchiveProfile

public class Profile
extends DeployElement
implements oracle.jdeveloper.deploy.common.Interdependency

Field Summary

protected DataContainer	_dataContainer
protected oracle.jdevimpl.deploy.common.DependableContainer	_dependableContainer
static java.lang.String	PROFILE_CLASS_NAME
static java.lang.String	PROFILE_DEPENDENCIES
static java.lang.String	PROFILE_NAME

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Constructor Summary

Profile()

Profile(HashStructure hash)

Method Summary

void	addDependency(Dependable dependable)
void	addDependency(Node node, DataContainer container)
void	addDependency(Profile profile)
java.lang.Object	copyTo(java.lang.Object object) Copy support.
protected void	copyToImpl(java.lang.Object object)
boolean	equals(java.lang.Object o) Equals support.
protected boolean	equalsImpl(Profile profile)
DataContainer	getDataContainer()
java.lang.String	getDefaultLibraryFileGroupName()
java.lang.String	getDefaultLibraryFileGroupTargetWithinJar()
java.util.Iterator<Dependable>	getDependencies()
HashStructure	getHashStructure() Returns the HashStructure this adapter is adapting.
oracle.jdeveloper.deploy.common.LibraryDependencies	getLibraryDependencies()
java.lang.String	getName()
java.lang.String	getParentProfileName() Deprecated. Profiles heirarchy not a part of base infrastructure. A composite should be used if specific implementations require this.
static <T extends Profile> java.lang.Class<T>	getProfileClass(HashStructure hash, java.lang.ClassLoader loader) Returns the Class for a Profile.
protected static java.lang.String	getProfileNameFromRef(java.lang.String profileRef) Deprecated.
java.lang.String	getShortLabel() Returns a short label that can be displayed to the user.
java.lang.Object[]	getUnSelectedLibraryDependencies() Returns the the list of library dependencies that are explicitly Unselected by the user.
boolean	isContainedProfile() Deprecated.
void	migrate(TraversableContext tc)
Dependable	removeDependency(Dependable dependable)
Dependable	removeDependency(Profile profile) Remove a dependency to a Profile.
protected static void	resolveProfileDependencies(Project project, Profile profile, oracle.jdevimpl.deploy.DeploymentProfilesMigrator migrator)
boolean	resolvesLibrary(oracle.jdevimpl.deploy.common.DependentLibrary library) This method indicates whether this profile resolves the given library.
void	setContainedProfile(boolean containedProfile) Deprecated. Containment is not for the profile to track, hence should not be a property.
void	setDataContainer(DataContainer dataContainer)
void	setLibraryDependencies(oracle.jdeveloper.deploy.common.LibraryDependencies libraryDependencies)
void	setName(java.lang.String name)
static <T extends Profile> void	setProfileClass(Profile profile, java.lang.Class<T> profileClass) Set the type of Profile.
void	setUnSelectedLibraryDependencies(java.lang.Object[] unSelectedLibraryDependencies)

Methods inherited from class oracle.jdeveloper.deploy.dt.DeployElement

attach, detach, getAttributes, getChildren, getData, getIcon, getLongLabel, getToolTipText, isDirty, linkContainingDirtyable, linkEmbeddedDirtyable, linkEmbeddedDirtyable, linkEmbeddedDirtyables, markDirty, mayHaveChildren, notifyObservers, setOwner, toString, unlinkContainingDirtyable, unlinkEmbeddedDirtyable, unlinkEmbeddedDirtyable, unlinkEmbeddedDirtyables

Methods inherited from class oracle.javatools.data.HashStructureAdapter

addStructureChangeListener, containsKey, copyToImpl, equalsImpl, findOrCreate, forcedCopyTo, removeStructureChangeListener, useObjectEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROFILE_NAME

public static java.lang.String PROFILE_NAME

PROFILE_CLASS_NAME

public static java.lang.String PROFILE_CLASS_NAME

PROFILE_DEPENDENCIES

public static java.lang.String PROFILE_DEPENDENCIES

_dependableContainer

protected oracle.jdevimpl.deploy.common.DependableContainer _dependableContainer

_dataContainer

protected DataContainer _dataContainer

Constructor Detail

Profile

public Profile()

Profile

public Profile(HashStructure hash)

Method Detail

equals

public boolean equals(java.lang.Object o)

Description copied from class: HashStructureAdapter

Equals support. As long as the subclass stores all data in the HashStructureAdapter._hash, this base equals implementation should be sufficient and not need to be overridden.

Overrides:

equals in class HashStructureAdapter

equalsImpl

protected final boolean equalsImpl(Profile profile)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

setProfileClass

public static <T extends Profile> void setProfileClass(Profile profile,
                                                       java.lang.Class<T> profileClass)

Set the type of Profile. A Class is used as opposed to string so that a basic validation can be made that the class does exist.

Parameters:

profileClass -

getProfileClass

public static <T extends Profile> java.lang.Class<T> getProfileClass(HashStructure hash,
                                                                     java.lang.ClassLoader loader)
                                                          throws java.lang.ClassNotFoundException

Returns the Class for a Profile.

Parameters:

loader - the ClassLoader to use to load the Class. If null, the context class loader will be used

Returns:

Throws:

java.lang.ClassNotFoundException - if the class is not known or it cannot be loaded.

copyTo

public java.lang.Object copyTo(java.lang.Object object)

Description copied from class: HashStructureAdapter

Copy support. The specified target must not be null and must be the exact same type as this instance.

Overrides:

copyTo in class HashStructureAdapter

copyToImpl

protected final void copyToImpl(java.lang.Object object)

getHashStructure

public HashStructure getHashStructure()

Description copied from class: HashStructureAdapter

Returns the HashStructure this adapter is adapting.

Overrides:

getHashStructure in class HashStructureAdapter

Returns:

the HashStructure this adapter is adapting.

getDataContainer

public DataContainer getDataContainer()

Returns:

The DataContainer associated with this Profile. This will either be an instance of a Project or Workspace.

setDataContainer

public void setDataContainer(DataContainer dataContainer)

Parameters:

dataContainer - is the DataContainer associated with the Profile. This will either be an instance of a Project or Workspace. The dataContainer is set at profile creation time in Deployment.createDeploymentProfile and in DeploymentProfiles when read from disk.

getDependencies

public java.util.Iterator<Dependable> getDependencies()

Specified by:

getDependencies in interface oracle.jdeveloper.deploy.common.Interdependency

Returns:

an Iterator of Dependable objects representing the objects that this profile depends on for deployment.

addDependency

public void addDependency(Profile profile)

Parameters:

profile - the profile object to be added as a dependency to this profile. This object represents an object that this profile depends on for deployment.

removeDependency

public Dependable removeDependency(Profile profile)

Remove a dependency to a Profile. The equals() check is used to find the profile, non-existent profiles will not be matched.

Parameters:

profile - the profile to which the dependency should be removed.

Returns:

the Dependable removed, null if not found.

addDependency

public void addDependency(Node node,
                          DataContainer container)

Parameters:

node - the jarNode object to be added as a dependency to this profile. This object represents an object that this profile depends on for deployment.

addDependency

public void addDependency(Dependable dependable)

Specified by:

addDependency in interface oracle.jdeveloper.deploy.common.Interdependency

Parameters:

dependable - the dependable object to be added as a dependency to this profile. This object represents an object that this profile depends on for deployment.

removeDependency

public Dependable removeDependency(Dependable dependable)

Specified by:

removeDependency in interface oracle.jdeveloper.deploy.common.Interdependency

Parameters:

dependable - removes the dependency of this profile on the specified dependable.

Returns:

the dependable being removed.

getLibraryDependencies

public oracle.jdeveloper.deploy.common.LibraryDependencies getLibraryDependencies()

setLibraryDependencies

public void setLibraryDependencies(oracle.jdeveloper.deploy.common.LibraryDependencies libraryDependencies)

getUnSelectedLibraryDependencies

public java.lang.Object[] getUnSelectedLibraryDependencies()

Returns the the list of library dependencies that are explicitly Unselected by the user. If no libraries are explicitly unselected, this method returns null.

setUnSelectedLibraryDependencies

public void setUnSelectedLibraryDependencies(java.lang.Object[] unSelectedLibraryDependencies)

getDefaultLibraryFileGroupName

public java.lang.String getDefaultLibraryFileGroupName()

getDefaultLibraryFileGroupTargetWithinJar

public java.lang.String getDefaultLibraryFileGroupTargetWithinJar()

getShortLabel

public java.lang.String getShortLabel()

Description copied from interface: Displayable

Returns a short label that can be displayed to the user. Generally, the value of the returned String is considered translatable and should therefore be placed in an appropriate resource file. When possible, the returned label should be reasonably short enough to show in the navigator or explorer windows but long enough to clearly identify and distinguish the Displayable.

Specified by:

getShortLabel in interface Displayable

Overrides:

getShortLabel in class DeployElement

Returns:

a short descriptive label of the Displayable that can be shown to the user.

resolvesLibrary

public boolean resolvesLibrary(oracle.jdevimpl.deploy.common.DependentLibrary library)

This method indicates whether this profile resolves the given library. Profiles typically resolve libraries by including them in their library filegroups although different profile types could have various implementation.

Parameters:

library - The library to be evaluated.

Returns:

true if the library is resolved by this profile, false otherwise.

setContainedProfile

@Deprecated
public void setContainedProfile(boolean containedProfile)

Deprecated. Containment is not for the profile to track, hence should not be a property.

isContainedProfile

@Deprecated
public boolean isContainedProfile()

Deprecated.

getParentProfileName

@Deprecated
public java.lang.String getParentProfileName()

Deprecated. Profiles heirarchy not a part of base infrastructure. A composite should be used if specific implementations require this.

Returns:

getProfileNameFromRef

@Deprecated
protected static java.lang.String getProfileNameFromRef(java.lang.String profileRef)

Deprecated.

Returns:

the name of a profile given it's full ref part (the ref part is the same as the name for regular profiles but is a subset of the ref for contained profiles (for a contained profile with a ref part of bcprofile1#bcprofile1_common1 for instance, it's name would be bcprofile1_common1).

resolveProfileDependencies

protected static void resolveProfileDependencies(Project project,
                                                 Profile profile,
                                                 oracle.jdevimpl.deploy.DeploymentProfilesMigrator migrator)

Parameters:

project - is the currently migrating project.

profile - is the profile for which you need profile dependencies resolved.

migrator - is the DeploymentProfilesMigrator instance that is used to resolve profile dependencies.

migrate

public void migrate(TraversableContext tc)

Parameters:

tc - is the traversable Context passed for migration with the addition of the following entries: project, profileURL, newRefPart and profileDepMap.