A C D E F G I L M N O P S T V

A

AActionPlugin - Class in org.pf.tools.cda.ui.xpi

The purpose of this abstract plugin implementation is to provide default implementations of methods that may be overridden by subclasses.

AActionPlugin() - Constructor for class org.pf.tools.cda.ui.xpi.AActionPlugin

abortExport() - Method in class org.pf.tools.cda.plugin.export.spi.AModelExporter

This method gets called if the export must be aborted due to user interrupt or any exception that occurred during export execution.

accept(IExplorableElementVisitor) - Method in interface org.pfsw.odem.IExplorableElementVisiting

Implementation of the visitor pattern (GOF) for all derived interfaces if IExplorableElement.

acceptContainers(IContainersVisitor) - Method in interface org.pfsw.odem.IStructureVisiting

Implementation of the visitor pattern (GOF).

acceptNamespaces(INamespacesVisitor) - Method in interface org.pfsw.odem.INamespace

Implementation of the visitor pattern (GOF).

acceptNamespaces(INamespacesVisitor) - Method in interface org.pfsw.odem.IStructureVisiting

Implementation of the visitor pattern (GOF).

acceptTypes(ITypesVisitor) - Method in interface org.pfsw.odem.IExplorableElementVisiting

Implementation of the visitor pattern (GOF) for all derived interfaces if IExplorableElement.

add(IDependency<S, T>) - Method in class org.pfsw.odem.DependencySet

Add a new dependency.

AModelExporter - Class in org.pf.tools.cda.plugin.export.spi

The purpose of this abstract exporter class is to provide default implementations of methods that may be overridden by subclasses.

AModelExporter() - Constructor for class org.pf.tools.cda.plugin.export.spi.AModelExporter

AModelExporterUIPlugin - Class in org.pf.tools.cda.ui.plugin.export.spi

The purpose of this abstract exporter plugin is to provide default implementations of methods that may be overridden by subclasses.

AModelExporterUIPlugin() - Constructor for class org.pf.tools.cda.ui.plugin.export.spi.AModelExporterUIPlugin

AModelObjectVisitor - Class in org.pf.tools.cda.xpi

Abstract definition of an object that gets called for all elements of the object model hierarchy.

AModelObjectVisitor() - Constructor for class org.pf.tools.cda.xpi.AModelObjectVisitor

Initialize the new instance with default values.

APluginImplementation - Class in org.pf.tools.cda.xpi

Abstract superclass of plug-in implementations

ASubWindowPlugin - Class in org.pf.tools.cda.ui.plugin.spi

This abstract class specifies the methods to be implemented by all subclasses that are intended to provide a sub-window to the main application.

C

close() - Method in class org.pf.tools.cda.ui.plugin.spi.ASubWindowPlugin

This method must be called in order to close this plug-in with its window and automatically inform its controller.

collect(IDependencyFilter<IDependency<S, T>>) - Method in class org.pfsw.odem.DependencySet

Return a list of all dependencies that match the given filter.

collectForClassification(DependencyClassification) - Method in class org.pfsw.odem.DependencySet

Return a list of all dependencies with the given classification.

collectInto(Collection<IDependency<S, T>>, IDependencyFilter<IDependency<S, T>>) - Method in class org.pfsw.odem.DependencySet

Adds all dependencies that match the given filter to the provided collection.

ContainerClassification - Enum in org.pfsw.odem

Specifies the currently container types

copy() - Method in class org.pfsw.odem.DependencySet

Returns a copy of this dependency set that contains the identical dependency objects (i.e. no deep copy).

createExporter(PluginConfiguration) - Method in class org.pf.tools.cda.ui.plugin.export.spi.AModelExporterUIPlugin

Returns a new instance of an exporter.

createFrame(IExplorationModelObject) - Method in class org.pf.tools.cda.ui.plugin.spi.ASubWindowPlugin

This method must be implemented to create the whole UI of the new window.

D

DependencyClassification - Enum in org.pfsw.odem

Specifies the currently supported types

DependencySet<S extends IExplorableElement,T extends IExplorableElement> - Class in org.pfsw.odem

A set of IDependency objects.

DependencySet() - Constructor for class org.pfsw.odem.DependencySet

Initialize the new instance with a default capcity of 50.

DependencySet(int) - Constructor for class org.pfsw.odem.DependencySet

Initialize the new instance with an initial capacity.

dispose() - Method in class org.pf.tools.cda.ui.plugin.spi.ASubWindowPlugin

This method will be called right before the plug-in gets closed.

E

EMPTY_ARRAY - Static variable in interface org.pf.tools.cda.ui.xpi.IPluginActionInfo

EMPTY_CONTAINER_ARRAY - Static variable in interface org.pfsw.odem.IContainer

An empty array of IContainer elements that can be used as return value in implementations whenever an empty array is needed.

EMPTY_NAMESPACE_ARRAY - Static variable in interface org.pfsw.odem.INamespace

An empty array of INamespace elements that can be used as return value in implementations whenever an empty array is needed.

EMPTY_TYPE_ARRAY - Static variable in interface org.pfsw.odem.IType

An empty array of IType elements that can be used as return value in implementations whenever an empty array is needed.

executionFinished() - Method in interface org.pf.tools.cda.xpi.IIntegrationService

This method must be called by a when it has finished its work.

ExportException - Exception in org.pf.tools.cda.plugin.export.spi

Superclass for all exceptions that can occur during the export of CDA data.

ExportException(String) - Constructor for exception org.pf.tools.cda.plugin.export.spi.ExportException

Initialize the new instance with a message.

ExportException(String, Throwable) - Constructor for exception org.pf.tools.cda.plugin.export.spi.ExportException

Initialize the new instance with a message and another exception.

F

finishContainer(IContainer) - Method in class org.pf.tools.cda.xpi.AModelObjectVisitor

Will be called when process of the specified container can be finished.

finishContext(IExplorationContext) - Method in class org.pf.tools.cda.xpi.AModelObjectVisitor

Will be called when process of the specified context can be finished.

finishExport() - Method in class org.pf.tools.cda.plugin.export.spi.AModelExporter

This method gets called after all data has been passed to the exporter and so far no exception or cancellation occurred.

finishModelObject(IExplorationModelObject) - Method in class org.pf.tools.cda.xpi.AModelObjectVisitor

Will be called when the object model visiting is finished.

finishNamespace(INamespace) - Method in class org.pf.tools.cda.xpi.AModelObjectVisitor

Will be called when process of the specified namespace can be finished.

finishType(IType) - Method in class org.pf.tools.cda.xpi.AModelObjectVisitor

Will be called when process of the specified type can be finished.

fromString(String) - Static method in enum org.pfsw.odem.ContainerClassification

Returns the enum value with the given name.

fromString(String) - Static method in enum org.pfsw.odem.DependencyClassification

Returns the enum value with the given name.

fromString(String) - Static method in enum org.pfsw.odem.TypeClassification

Returns the enum value with the given name.

fromString(String) - Static method in enum org.pfsw.odem.Visibility

Returns the enum value with the given name.

G

get(String) - Method in class org.pf.tools.cda.xpi.PluginConfiguration

Returns the configuration object stored under the specified key or null if the key is unknown.

getActionText(Locale, IExplorationModelObject) - Method in interface org.pf.tools.cda.ui.xpi.IPluginActionInfo

This method must return the text to display in UI elements (e.g menu item, button) on the given object.

getClassification() - Method in interface org.pfsw.odem.IContainer

Returns the classification of this container.

getClassification() - Method in interface org.pfsw.odem.IType

Returns the classification (i.e.

getConfiguration(Frame) - Method in class org.pf.tools.cda.ui.plugin.export.spi.AModelExporterUIPlugin

Returns the configuration data that might be necessary to execute the plugin's functionality

getConfiguration(Frame) - Method in class org.pf.tools.cda.ui.plugin.spi.ASubWindowPlugin

Returns the configuration data that might be necessary to execute the plugin's functionality

getConfiguration(Frame) - Method in interface org.pf.tools.cda.ui.xpi.IPluginActionInfo

The method gets called to allow the plug-in collecting configuration parameters if necessary for execution.

getContainers() - Method in interface org.pfsw.odem.IExplorationContext

Returns all containers of this exploration context.

getContext() - Method in interface org.pfsw.odem.IExplorationModelObject

Returns the exploration context the element belongs to

getDependencies() - Method in interface org.pfsw.odem.IType

Returns all dependencies to other types.

getDependencyClassification() - Method in interface org.pfsw.odem.IDependency

Returns what kind of dependency it is

getDescription() - Method in interface org.pfsw.odem.IExplorationContext

Returns a text that describes the context.

getDirectReferredTypes() - Method in interface org.pfsw.odem.IType

Returns all types this type directly depends on.

getDisabledIconFilename(IExplorationModelObject) - Method in class org.pf.tools.cda.ui.xpi.AActionPlugin

Returns the name of an icon file that should be shown in the UI when the plug-in cannot be used.

getDisabledIconFilename(IExplorationModelObject) - Method in interface org.pf.tools.cda.ui.xpi.IPluginActionInfo

Returns the name of an icon file that should be shown in the UI when the plug-in cannot be used.

getEnabledIconFilename(IExplorationModelObject) - Method in class org.pf.tools.cda.ui.xpi.AActionPlugin

Returns the filename of an icon image to that should be shown if the plug-in can be used.

getEnabledIconFilename(IExplorationModelObject) - Method in interface org.pf.tools.cda.ui.xpi.IPluginActionInfo

Returns the filename of an icon image to that should be shown if the plug-in can be used.

getExplorationContext() - Method in interface org.pf.tools.cda.xpi.IIntegrationService

Returns the context in which the plug-in was opend.

getIntegrationService() - Method in class org.pf.tools.cda.ui.plugin.spi.ASubWindowPlugin

Returns the integration service that is the interface to the main application.

getKeys() - Method in class org.pf.tools.cda.xpi.PluginConfiguration

Returns an array of all keys currently available in the configuration.

getName() - Method in interface org.pfsw.odem.IExplorationModelObject

Returns the identifying name of the model object

getNamespace() - Method in interface org.pfsw.odem.IType

Returns the namespace the type belongs to.

getNamespaces() - Method in interface org.pfsw.odem.IContainer

Returns all namespaces in this container.

getParentContainer() - Method in interface org.pfsw.odem.IContainer

Returns the parent container of this container.

getPluginId() - Method in class org.pf.tools.cda.plugin.export.spi.AModelExporter

Returns the exporte's id

getPluginId() - Method in class org.pf.tools.cda.xpi.APluginImplementation

Returns an identifier which must be unique ragarding the IDs of all plug-ins.

getPluginId() - Method in interface org.pf.tools.cda.xpi.IPluginInfo

Returns an identifier which must be unique ragarding the IDs of all exporters.

getPluginProvider() - Method in interface org.pf.tools.cda.xpi.IPluginInfo

Returns the name of the provider (i.e. person, organization or company) of the plugin.

getPluginVersion() - Method in interface org.pf.tools.cda.xpi.IPluginInfo

Returns the version of this plugin (e.g. "1.2") ;

getProperty(String) - Method in interface org.pfsw.odem.IObjectProperties

Returns the property associated with the given name.

getProperty(String) - Method in class org.pfsw.odem.ObjectProperties

Returns the property associated with the given name.

getPropertyNames() - Method in interface org.pfsw.odem.IObjectProperties

Returns all currently known properties.

getPropertyNames() - Method in class org.pfsw.odem.ObjectProperties

Returns all currently known properties.

getSourceElement() - Method in interface org.pfsw.odem.IDependency

Returns the element that depends on the target element

getSubContainers() - Method in interface org.pfsw.odem.IContainer

Returns all sub containers of this container.

getTargetElement() - Method in interface org.pfsw.odem.IDependency

Returns the element the source element depends on

getToolTipText(Locale, IExplorationModelObject) - Method in class org.pf.tools.cda.ui.xpi.AActionPlugin

Returns the text that should be shown as tooltip for this plug-in.

getToolTipText(Locale, IExplorationModelObject) - Method in interface org.pf.tools.cda.ui.xpi.IPluginActionInfo

Returns the text that should be shown as tooltip for this action.

getTypes() - Method in interface org.pfsw.odem.INamespace

Returns all types in this namespace.

getUnqualifiedName() - Method in interface org.pfsw.odem.IType

Returns the name without the namespace

getVisibility() - Method in interface org.pfsw.odem.IType

Returns the visibility of this type.

I

IContainer - Interface in org.pfsw.odem

Represents a containers that hold types and namespaces.

IContainersVisitor - Interface in org.pfsw.odem

This interface defines one part of the "Visitor Pattern".

IDependency<S extends IExplorableElement,T extends IExplorableElement> - Interface in org.pfsw.odem

Represents a directed dependency between two IExplorableElements.

IDependencyFilter<D extends IDependency> - Interface in org.pfsw.odem

Simple filter for IDependency objects

IExplorableElement - Interface in org.pfsw.odem

Common interface for all model objects that can be used for dependency exploration.

IExplorableElementFilter<E extends IExplorableElement> - Interface in org.pfsw.odem

Simple filter for IExplorableElement objects

IExplorableElementVisiting - Interface in org.pfsw.odem

Specifies all methods that are necessary to fully provide the "Vistor Pattern" in conjunction with the IxxxVisitor interfaces defined here in the same package.

IExplorableElementVisitor - Interface in org.pfsw.odem

This is the callback interface an object must implement to be used within a transparent navigation over all explorable elements.

IExplorationContext - Interface in org.pfsw.odem

Exploration of dependencies always must happen in a particular context.

IExplorationModelObject - Interface in org.pfsw.odem

This is the base interface of all objects that comprise the exploration model.

IIntegrationService - Interface in org.pf.tools.cda.xpi

This interface describes all service methods that are available to plug-ins to interact and integrate seamlessly with the main application.

INamespace - Interface in org.pfsw.odem

Represents a namespace an IType belongs to.

INamespacesVisitor - Interface in org.pfsw.odem

This interface defines one part of the "Visitor Pattern".

initialize(PluginConfiguration) - Method in class org.pf.tools.cda.plugin.export.spi.AModelExporter

Initialize the exporter with external configuration data.

initialize(PluginConfiguration) - Method in class org.pf.tools.cda.ui.plugin.spi.ASubWindowPlugin

This method will be called right after the plug-in has been created and connected to the internal structures.

IObjectProperties - Interface in org.pfsw.odem

Each object that supports generic attributes must implement this interface.

IPluginActionInfo - Interface in org.pf.tools.cda.ui.xpi

Defines the methods that provide meta data about a plug-in action.

IPluginInfo - Interface in org.pf.tools.cda.xpi

Defines the methods that provide meta data about a plugin.

isAbstract() - Method in interface org.pfsw.odem.IType

Returns whether or not this type is abstract.

isDerived() - Method in class org.pfsw.odem.TypeDependency

Returns true if the source type of this dependency either extends or implements the target type.

isDirectExtensionOf(IType) - Method in interface org.pfsw.odem.IType

Returns true if this type extends the given type directly.

isDirectImplementorOf(IType) - Method in interface org.pfsw.odem.IType

Returns true if this type directly implements the given type.

isExtension() - Method in class org.pfsw.odem.TypeDependency

Returns true if the source type of this dependency extends the target type.

isFinal() - Method in interface org.pfsw.odem.IType

Returns whether or not this type is final.

isImplementation() - Method in class org.pfsw.odem.TypeDependency

Returns true if the source type of this dependency implements the target (interface) type.

isParamTypeInMethod() - Method in class org.pfsw.odem.TypeDependency

Returns true if the target type of this dependency is the type of a method parameter in one of the source type's methods.

isReferencedInMethodSignature() - Method in class org.pfsw.odem.TypeDependency

Returns true if the target type of this dependency is used in one of the source type's methods.

isReturnTypeOfMethod() - Method in class org.pfsw.odem.TypeDependency

Returns true if the target type of this dependency is the type of a method parameter in one of the source type's methods.

IStructureVisiting - Interface in org.pfsw.odem

Specifies the methods a holder of exploration structures such as namespaces and containers must implement.

isTypeOfField() - Method in class org.pfsw.odem.TypeDependency

Returns true if the target type of this dependency is the type of a field (i.e. instance variable or static variable) in source type.

isTypeOfLocalVariable() - Method in class org.pfsw.odem.TypeDependency

Returns true if the target type of this dependency is the type of a local variable (i.e. a field declared locally inside a method) in source type.

IType - Interface in org.pfsw.odem

Represents a type such as a class, an interface, an enumeration and so on.

ITypesVisitor - Interface in org.pfsw.odem

This interface defines one part of the "Visitor Pattern".

L

lookupSourceElement(S) - Method in class org.pfsw.odem.DependencySet

Returns the first dependency with the source element equal to the given element.

lookupTargetElement(T) - Method in class org.pfsw.odem.DependencySet

Returns the first dependency with the a target element equal to the given element.

M

matches(D) - Method in interface org.pfsw.odem.IDependencyFilter

Returns true if the given dependency matches the filter, otherwise false.

matches(E) - Method in interface org.pfsw.odem.IExplorableElementFilter

Returns true if the given element matches the filter, otherwise false.

N

newList(int) - Method in class org.pfsw.odem.DependencySet

Returns a new list to hold dependency objects of the correct type.

O

ObjectProperties - Class in org.pfsw.odem

This is an implementation of IObjectProperties which is provided here as convenience, so that not everybody is forced create his own implementation.

ObjectProperties() - Constructor for class org.pfsw.odem.ObjectProperties

Initialize the new instance with default values.

org.pf.tools.cda.plugin.export.spi - package org.pf.tools.cda.plugin.export.spi

Export Service Programming Interface
This package provides an abstract superclass for classes that are supposed to export parts or the whole data model of CDA.

org.pf.tools.cda.ui.plugin.export.spi - package org.pf.tools.cda.ui.plugin.export.spi

UI Export Service Provider Interface
This package contains abstract classes which represent extension-points for UI integration of custom model export implementations.

org.pf.tools.cda.ui.plugin.spi - package org.pf.tools.cda.ui.plugin.spi

UI Service Provider Interface
This package contains abstract classes which represent extension-points for UI integration of custom implementations.

org.pf.tools.cda.ui.xpi - package org.pf.tools.cda.ui.xpi

Extension Point Interface
This package contains classes that are the base of CDA's plug-in framework.

org.pf.tools.cda.xpi - package org.pf.tools.cda.xpi

Extension Point Interface
This package contains classes that are the base of CDA's UI plug-in framework.

org.pfsw.odem - package org.pfsw.odem

Object Dependency Exploration Model (ODEM)
This component provides an API for analyzing type dependencies.

P

PARAM_OUTPUT_FILENAME - Static variable in class org.pf.tools.cda.plugin.export.spi.AModelExporter

Defines the parameter name of the configuration setting for the initialize() method that specifies the filename to which the output must be written.

PluginConfiguration - Class in org.pf.tools.cda.xpi

This is the container class for generic plugin configuration.

PluginConfiguration() - Constructor for class org.pf.tools.cda.xpi.PluginConfiguration

Initialize the new instance with default values.

prepareExport() - Method in class org.pf.tools.cda.plugin.export.spi.AModelExporter

This method is called to initiate an export.

S

set(String, Object) - Method in class org.pf.tools.cda.xpi.PluginConfiguration

Stores the given configuration object under the specified key.

setId(String) - Method in class org.pf.tools.cda.plugin.export.spi.AModelExporter

Returns the exporte's id

setIntegrationService(IIntegrationService) - Method in class org.pf.tools.cda.ui.plugin.spi.ASubWindowPlugin

Do NOT call this method.

setPluginId(String) - Method in class org.pf.tools.cda.xpi.APluginImplementation

Sets the identifier of this plugin.

setProperty(String, Object) - Method in interface org.pfsw.odem.IObjectProperties

Sets the value of the property with the specified name to the given object.

setProperty(String, Object) - Method in class org.pfsw.odem.ObjectProperties

Sets the value of the property with the specified name to the given object.

startContainer(IContainer) - Method in class org.pf.tools.cda.xpi.AModelObjectVisitor

Will be called to process the specified container.

startContext(IExplorationContext) - Method in class org.pf.tools.cda.xpi.AModelObjectVisitor

Will be called to process the specified context.

startModelObject(IExplorationModelObject) - Method in class org.pf.tools.cda.xpi.AModelObjectVisitor

Will be called to process the specified model object.

startNamespace(INamespace) - Method in class org.pf.tools.cda.xpi.AModelObjectVisitor

Will be called to process the specified namespace.

startType(IType) - Method in class org.pf.tools.cda.xpi.AModelObjectVisitor

Will be called to process the specified type.

T

toString() - Method in enum org.pfsw.odem.ContainerClassification

toString() - Method in enum org.pfsw.odem.DependencyClassification

toString() - Method in enum org.pfsw.odem.TypeClassification

toString() - Method in enum org.pfsw.odem.Visibility

TypeClassification - Enum in org.pfsw.odem

Specifies the currently supported types

TypeDependency<S extends IType,T extends IType> - Class in org.pfsw.odem

This abstract dependency class implements some convenience methods to find out the kind of dependency between two types.

TypeDependency() - Constructor for class org.pfsw.odem.TypeDependency

Initialize the new instance with default values.

V

valueOf(String) - Static method in enum org.pfsw.odem.ContainerClassification

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.pfsw.odem.DependencyClassification

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.pfsw.odem.TypeClassification

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.pfsw.odem.Visibility

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.pfsw.odem.ContainerClassification

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum org.pfsw.odem.DependencyClassification

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum org.pfsw.odem.TypeClassification

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum org.pfsw.odem.Visibility

Returns an array containing the constants of this enum type, in the order they're declared.

Visibility - Enum in org.pfsw.odem

Specifies the currently supported types

visitContainer(IContainer) - Method in interface org.pfsw.odem.IContainersVisitor

Will be called for each IContainer object.

visitNamespace(INamespace) - Method in interface org.pfsw.odem.INamespacesVisitor

Will be called for each INamespace object.

visitType(IType) - Method in interface org.pfsw.odem.ITypesVisitor

Will be called for each IType object.

A C D E F G I L M N O P S T V