Package adams.flow.transformer

Class SetDatabaseID

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class SetDatabaseID
extends AbstractTransformer
    Updates the database ID of the database ID handler passing through with the provided 'ID' value. Attach a variable to the 'ID' option to allow for more flexibility.

    Input/output:
    - accepts:
       adams.data.id.MutableDatabaseIDHandler
       adams.data.id.MutableLargeDatabaseIDHandler
    - generates:
       adams.data.id.MutableDatabaseIDHandler
       adams.data.id.MutableLargeDatabaseIDHandler


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: SetDatabaseID
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -id <java.lang.Long> (property: ID)
    The new database ID to use.
    default: -1
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_ID

        protected Long m_ID
        the database ID to set.

    • Constructor Detail

      • SetDatabaseID

        public SetDatabaseID()

    • Method Detail

      • setID

        public void setID​(Long value)
        Sets the new database ID to use.
        Parameters:
        value - the ID

      • getID

        public Long getID()
        Returns the database ID to use.
        Returns:
        the ID

      • IDTipText

        public String IDTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        adams.data.id.MutableDatabaseIDHandler.class, adams.data.id.MutableLargeDatabaseIDHandler.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        adams.data.id.MutableDatabaseIDHandler.class, adams.data.id.MutableLargeDatabaseIDHandler.class

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message