Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.common.align.extension.function
Class AbstractFunction<P extends AbstractParameter>

java.lang.Object
  extended by eu.esdihumboldt.hale.common.align.extension.function.AbstractFunction<P>
Type Parameters:
P - the parameter type
All Implemented Interfaces:
de.cs3d.util.eclipse.extension.simple.IdentifiableExtension.Identifiable, Function
Direct Known Subclasses:
PropertyFunction, TypeFunction

@Immutable
public abstract class AbstractFunction<P extends AbstractParameter>
extends Object
implements Function

IConfigurationElement based function base class

Author:
Simon Templer

Field Summary
protected  org.eclipse.core.runtime.IConfigurationElement conf
          The configuration element
 
Constructor Summary
protected AbstractFunction(org.eclipse.core.runtime.IConfigurationElement conf)
          Create a function definition based on the given configuration element
 
Method Summary
 boolean equals(Object obj)
           
 String getCategoryId()
          Get the ID of the function's category
 Collection<FunctionParameter> getDefinedParameters()
          Get the defined parameters for the function
 String getDefiningBundle()
          Get the symbolic name of the bundle defining the function.
 String getDescription()
          Get the function description
 String getDisplayName()
          Get the human readable name of the function
 CellExplanation getExplanation()
          Get the associated cell explanation.
 URL getHelpURL()
          Get the help file URL
 URL getIconURL()
          Get the icon URL
 String getId()
           
 FunctionParameter getParameter(String paramName)
          Get the function parameter with the given name.
abstract  Set<? extends P> getSource()
          Get the source entities
abstract  Set<? extends P> getTarget()
          Get the target entities
 int hashCode()
           
 boolean isAugmentation()
          States if the function represents an augmentation of a target instance instead of a transformation.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

conf

protected final org.eclipse.core.runtime.IConfigurationElement conf
The configuration element

Constructor Detail

AbstractFunction

protected AbstractFunction(org.eclipse.core.runtime.IConfigurationElement conf)
Create a function definition based on the given configuration element

Parameters:
conf - the configuration element
Method Detail

getExplanation

public CellExplanation getExplanation()
Description copied from interface: Function
Get the associated cell explanation.

Specified by:
getExplanation in interface Function
Returns:
the cell explanation or null if none is available for this function
See Also:
Function.getExplanation()

getSource

public abstract Set<? extends P> getSource()
Get the source entities

Specified by:
getSource in interface Function
Returns:
the source entities

getTarget

public abstract Set<? extends P> getTarget()
Get the target entities

Specified by:
getTarget in interface Function
Returns:
the target entities

isAugmentation

public boolean isAugmentation()
States if the function represents an augmentation of a target instance instead of a transformation.

Returns:
if the function is an augmentation

getId

public final String getId()
Specified by:
getId in interface de.cs3d.util.eclipse.extension.simple.IdentifiableExtension.Identifiable
See Also:
IdentifiableExtension.Identifiable.getId()

getDefiningBundle

public String getDefiningBundle()
Description copied from interface: Function
Get the symbolic name of the bundle defining the function.

Specified by:
getDefiningBundle in interface Function
Returns:
the bundle symbolic name
See Also:
Function.getDefiningBundle()

getDisplayName

public final String getDisplayName()
Description copied from interface: Function
Get the human readable name of the function

Specified by:
getDisplayName in interface Function
Returns:
the function name
See Also:
Function.getDisplayName()

getDescription

public final String getDescription()
Description copied from interface: Function
Get the function description

Specified by:
getDescription in interface Function
Returns:
the description, may be null
See Also:
Function.getDescription()

getCategoryId

public final String getCategoryId()
Description copied from interface: Function
Get the ID of the function's category

Specified by:
getCategoryId in interface Function
Returns:
the category ID, may be null
See Also:
Function.getCategoryId()

getDefinedParameters

public final Collection<FunctionParameter> getDefinedParameters()
Description copied from interface: Function
Get the defined parameters for the function

Specified by:
getDefinedParameters in interface Function
Returns:
the defined parameters
See Also:
Function.getDefinedParameters()

getParameter

public FunctionParameter getParameter(String paramName)
Get the function parameter with the given name.

Parameters:
paramName - the parameter name
Returns:
the parameter or null if it doesn't exist

getIconURL

public URL getIconURL()
Description copied from interface: Function
Get the icon URL

Specified by:
getIconURL in interface Function
Returns:
the icon URL, may be null
See Also:
Function.getIconURL()

getHelpURL

public URL getHelpURL()
Description copied from interface: Function
Get the help file URL

Specified by:
getHelpURL in interface Function
Returns:
the help file URL, may be null
See Also:
Function.getHelpURL()

hashCode

public int hashCode()
Overrides:
hashCode in class Object
See Also:
Object.hashCode()

equals

public boolean equals(Object obj)
Overrides:
equals in class Object
See Also:
Object.equals(Object)

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d