Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.common.align.extension.function
Interface Function

All Superinterfaces:
de.cs3d.util.eclipse.extension.simple.IdentifiableExtension.Identifiable
All Known Implementing Classes:
AbstractFunction, PropertyFunction, TypeFunction

public interface Function
extends de.cs3d.util.eclipse.extension.simple.IdentifiableExtension.Identifiable

Basic interface for function definitions

Author:
Simon Templer

Method Summary
 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
 Set<? extends AbstractParameter> getSource()
          Get the source entities
 Set<? extends AbstractParameter> getTarget()
          Get the target entities
 
Methods inherited from interface de.cs3d.util.eclipse.extension.simple.IdentifiableExtension.Identifiable
getId
 

Method Detail

getDisplayName

String getDisplayName()
Get the human readable name of the function

Returns:
the function name

getDescription

String getDescription()
Get the function description

Returns:
the description, may be null

getCategoryId

String getCategoryId()
Get the ID of the function's category

Returns:
the category ID, may be null

getDefinedParameters

Collection<FunctionParameter> getDefinedParameters()
Get the defined parameters for the function

Returns:
the defined parameters

getIconURL

URL getIconURL()
Get the icon URL

Returns:
the icon URL, may be null

getDefiningBundle

String getDefiningBundle()
Get the symbolic name of the bundle defining the function.

Returns:
the bundle symbolic name

getHelpURL

URL getHelpURL()
Get the help file URL

Returns:
the help file URL, may be null

getExplanation

CellExplanation getExplanation()
Get the associated cell explanation.

Returns:
the cell explanation or null if none is available for this function

getSource

Set<? extends AbstractParameter> getSource()
Get the source entities

Returns:
the source entities

getTarget

Set<? extends AbstractParameter> getTarget()
Get the target entities

Returns:
the target entities

Humboldt Alignment Editor 2.5.0

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