oracle.jdeveloper.audit.model

Class StructureDependency

java.lang.Object

oracle.jdeveloper.audit.model.Dependency

oracle.jdeveloper.audit.model.StructureDependency

public class StructureDependency
extends Dependency

A dependency on properties contained in Preferences, Workspaces, or Projects. These containers store properties in HashStructures which use slash-separated compound names to identify properties.

Most Audit dependencies on properties target one or a very few properties. For example, Java code analysis depends on the project JDK version which is a property of the project compiler settings. While it would be expedient to to invalidate after any project setting changes, it could result in a lot of wasted Java analysis if the user changes a JavaScript setting.

It can be a bit difficult to identify the actual name corresponding to a specific property. One option is to identify it in the saved XML file, since the names used in the XML are typically somewhat self-explanatory. Another option is to attach a StructureChangeListener to the project hash structure, manually change the property, and extract the information from the received event. Yet another option, if available, is to read source for the HashStructureAdapter typically provided as a facade for related groups of properties, for example, BuildSystemConfiguration for compile properties.

For projects and workspaces, a property can be identified by its full property name, for example:

   new StructureDependency(project, "oracle.jdeveloper.compiler.OjcConfiguration/source")
 

It can also be identified by an appropriate HashStructureAdapter instance and a name relative to the HashStructure to which it corresponds, for example:

   new StructureDependency(project, BuildSystemConfiguration.getInstance(project), "source")
 

The supplied property names are prefix matched, so all the project compile properties could be depended on with either of the following:

   new StructureDependency(project, "oracle.jdeveloper.compiler.OjcConfiguration")
   new StructureDependency(project, BuildSystemConfiguration.getInstance(project))
 

Constructor Summary

Constructors

Constructor and Description
StructureDependency(Preferences preferences, HashStructureAdapter scope, java.lang.String... properties) Creates a dependency on properties of a HashStructureAdapter of Preferences.
StructureDependency(Preferences preferences, java.lang.String... properties) Creates a dependency on properties of Preferences.
StructureDependency(Project project, HashStructureAdapter scope, java.lang.String... properties) Creates a dependency on properties of a HashStructureAdapter of a Project.
StructureDependency(Project project, java.lang.String... properties) Creates a dependency on properties of a Project.
StructureDependency(PropertyStorage container, HashStructureAdapter scope, java.lang.String... properties) Creates a dependency on properties of a HashStructureAdapter of a Project.
StructureDependency(Workspace workspace, HashStructureAdapter scope, java.lang.String... properties) Creates a dependency on properties of a HashStructureAdapter of a Workspace.
StructureDependency(Workspace workspace, java.lang.String... properties) Creates a dependency on properties of a Workspace.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	attach() Attach this dependency to its target.
protected void	detach() Detach this dependency from its target.
protected java.lang.String	getLongDescription() Gets a translated long description of the target of this dependency.
protected java.lang.String	getShortDescription() Gets a translated short description of the target of this dependency.

Methods inherited from class oracle.jdeveloper.audit.model.Dependency

addChangeListener, fireDependencyChanged, getChangeListener, isAttached, listenerDescription, removeChangeListener, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StructureDependency

public StructureDependency(Preferences preferences,
                   java.lang.String... properties)

Creates a dependency on properties of Preferences.

Parameters:

preferences - the preferences on which to depend.

properties - fully-qualified property names or name prefixes.

StructureDependency

public StructureDependency(Preferences preferences,
                   HashStructureAdapter scope,
                   java.lang.String... properties)

Creates a dependency on properties of a HashStructureAdapter of Preferences.

Parameters:

preferences - preferences on which to depend.

scope - a HashStructureAdapter scoping the properties.

properties - adapter-relative property names or name prefixes.

StructureDependency

public StructureDependency(Workspace workspace,
                   java.lang.String... properties)

Creates a dependency on properties of a Workspace.

Parameters:

workspace - the workspace on which to depend.

properties - fully-qualified property names or name prefixes.

StructureDependency

public StructureDependency(Workspace workspace,
                   HashStructureAdapter scope,
                   java.lang.String... properties)

Creates a dependency on properties of a HashStructureAdapter of a Workspace.

Parameters:

workspace - the workspace on which to depend.

scope - a HashStructureAdapter scoping the properties.

properties - adapter-relative property names or name prefixes.

StructureDependency

public StructureDependency(Project project,
                   java.lang.String... properties)

Creates a dependency on properties of a Project.

Parameters:

project - the project on which to depend.

properties - project-relative full names or prefixes of properties.

StructureDependency

public StructureDependency(Project project,
                   HashStructureAdapter scope,
                   java.lang.String... properties)

Creates a dependency on properties of a HashStructureAdapter of a Project.

Parameters:

project - the workspace on which to depend.

scope - a HashStructureAdapter scoping the properties.

properties - adapter-relative property names or name prefixes.

StructureDependency

public StructureDependency(PropertyStorage container,
                   HashStructureAdapter scope,
                   java.lang.String... properties)

Creates a dependency on properties of a HashStructureAdapter of a Project.

Parameters:

container - the workspace on which to depend.

scope - a HashStructureAdapter scoping the properties, null if none.

properties - relative property names or name prefixes.

Method Detail

attach

protected void attach()

Description copied from class: Dependency

Attach this dependency to its target.

Specified by:

attach in class Dependency

detach

protected void detach()

Description copied from class: Dependency

Detach this dependency from its target.

Specified by:

detach in class Dependency

getShortDescription

protected java.lang.String getShortDescription()

Description copied from class: Dependency

Gets a translated short description of the target of this dependency. For example, for a dependency on a file, gets the file name, not including the directory paths.

Specified by:

getShortDescription in class Dependency

getLongDescription

protected java.lang.String getLongDescription()

Description copied from class: Dependency

Gets a translated long description of the target of this dependency. For example, for a dependency on a file, gets the full path, including the directory paths.

Specified by:

getLongDescription in class Dependency