com.jbbres.lib.actions.tools.elements
Class AbstractElement

java.lang.Object
  extended by com.jbbres.lib.actions.tools.elements.AbstractElement
All Implemented Interfaces:
Element
Direct Known Subclasses:
AbstractAction, AbstractVariable

public abstract class AbstractElement
extends java.lang.Object
implements Element

This abstract class provides default implementations for most of the methods in the Element interface.

This class is not meant to be implemented directly. AbstractAction and AbstractVariable are to be implemented instead.

For more information on how to create your own elements, consult the Action(s) Developer Guide or visit http://app.jbbres.com/actions/developers/. Release Notes:

v1.1.0:

  • Added compatibility with module library v1.1
  • Since:
    1.0.0
    Version:
    1.1.0
    Author:
    Jean-Baptiste Bres
    See Also:
    AbstractAction, AbstractVariable

    Constructor Summary
    AbstractElement(Workflow workflow)
              Instantiates a new element.
     
    Method Summary
     ElementDescription<?> getDescription()
              Returns the description of the element.
     AbstractElementService getService()
              Returns the service associated to the element.
     Workflow getWorkflow()
              Returns the workflow that contains this element.
     
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
     
    Methods inherited from interface com.jbbres.lib.actions.elements.Element
    getParameters, setParameters
     

    Constructor Detail

    AbstractElement

    public AbstractElement(Workflow workflow)
                    throws java.io.IOException
    Instantiates a new element.

    Parameters:
    workflow - - the workflow
    Throws:
    java.io.IOException - Signals that an I/O exception has occurred when trying to read the element properties file.
    Method Detail

    getWorkflow

    public Workflow getWorkflow()
    Returns the workflow that contains this element.

    Returns:
    the workflow that contains this element

    getService

    public AbstractElementService getService()
    Description copied from interface: Element
    Returns the service associated to the element. The service describes how the element performs within the workflow. For example, if the element is an action, the service will contain the executable methods that the action is designed to perform. If the element is a variable, the service will contain methods related to data access.

    Specified by:
    getService in interface Element
    Returns:
    the service associated to the element.
    See Also:
    ElementService

    getDescription

    public ElementDescription<?> getDescription()
    Description copied from interface: Element
    Returns the description of the element. The description is a dictionary derived from the element description, usually the information specified in the element information property list.

    Specified by:
    getDescription in interface Element
    Returns:
    the description of the element.
    See Also:
    ElementDescription


    To file bugs or suggest feature enhancements, visit the app.jbbres.com Bug Reporter website.

    Additional documentation available online at http://app.jbbres.com/actions/developers.

    Copyright � 2009-2011 app.jbbres.com. All Rights Reserved.