Package de.uni_trier.wi2.procake.dependency

Interface DependencyModel

All Known Implementing Classes:

DependencyModelImpl

public interface DependencyModel

Interface, that defines the structure for the dependency model, where all dependencies are saved and retrieved during runtime.

Author:

Rahol Kumar, Alexander Schultheis

Method Summary

Modifier and Type	Method	Description
void	addDependencies(Collection<Dependency> dependencies)	Method, that adds a collection of dependencies to the dependency model.
void	addDependency(Dependency dependency)	Method, that adds a dependency to the dependency model.
void	addDependencySimilarity(DependencyType sourceDependencyType, DependencyType targetDependencyType, double similarity)	Method, that stores a similarity between two dependency types.
void	addDependencyType(DependencyType dependencyType)	Method, that stores a new dependency type in the model.
Set<Dependency>	getDependencies()	Method, that returns all dependencies saved in the model.
Set<Dependency>	getDependencies(String dependencyName, DataObject sourceObject, DataObject targetObject)	Method, that returns a set of dependencies, that match the given name of the dependency class and the used source and target objects.
double	getDependencySimilarity(DependencyType dependencyType1, DependencyType dependencyType2)
DependencyType	getDependencyType(String dependencyTypeName)	Method, that gets the name of a dependency type and returns the corresponding object.
Set<DependencyType>	getDependencyTypes()	Method, that returns the dependency types, which were saved in the dependency model.
Set<String>	getDependencyTypesAsString()	Method, that returns the names of the dependency types, which were used in the dependencies, saved in the model.

Method Detail

addDependency

void addDependency(Dependency dependency)

Method, that adds a dependency to the dependency model.

Parameters:

dependency - The dependency to be added to the model.

addDependencies

void addDependencies(Collection<Dependency> dependencies)

Method, that adds a collection of dependencies to the dependency model.

Parameters:

dependencies - The dependencies to be added to the model.

getDependencies

Set<Dependency> getDependencies()

Method, that returns all dependencies saved in the model.

Returns:

A set of all dependencies.

getDependencyTypesAsString

Set<String> getDependencyTypesAsString()

Method, that returns the names of the dependency types, which were used in the dependencies, saved in the model.

Returns:

A set of strings, containing the dependency type names.

getDependencyTypes

Set<DependencyType> getDependencyTypes()

Method, that returns the dependency types, which were saved in the dependency model.

Returns:

All available dependency types.

getDependencyType

DependencyType getDependencyType(String dependencyTypeName)

Method, that gets the name of a dependency type and returns the corresponding object.

Parameters:

dependencyTypeName - The name of the specific dependency type.

Returns:

The required dependency type. If it does not exist, null is returned.

getDependencies

Set<Dependency> getDependencies(String dependencyName,
                                DataObject sourceObject,
                                DataObject targetObject)

Method, that returns a set of dependencies, that match the given name of the dependency class and the used source and target objects.

Parameters:

dependencyName - The name of the dependency type.

sourceObject - The source object used in the dependency.

targetObject - The target object used in the dependency.

Returns:

A set of dependencies, that match the given constraints.

addDependencyType

void addDependencyType(DependencyType dependencyType)

Method, that stores a new dependency type in the model.

Parameters:

dependencyType - The dependency type, that should be added to the model.

addDependencySimilarity

void addDependencySimilarity(DependencyType sourceDependencyType,
                             DependencyType targetDependencyType,
                             double similarity)

Method, that stores a similarity between two dependency types. Both dependency types must exist in the model, otherwise, an exception is thrown.

Parameters:

sourceDependencyType - The dependency type from which the similarity originates.

targetDependencyType - The dependency type to which the similarity exists.

similarity - The similarity value between those both dependency types.

getDependencySimilarity

double getDependencySimilarity(DependencyType dependencyType1,
                               DependencyType dependencyType2)