*
Metamerge logo
Search

Advanced Search
*
*
*
* HOME DOCUMENTS & RESOURCES DOWNLOADS EARLY TECH ACCESS SUPPORT FAQ KNOWN ISSUES OLD VERSIONS
*

com.architech
Class rscTaskComponent

java.lang.Object
  |
  +--com.architech.rscTaskComponent

public class rscTaskComponent
extends java.lang.Object

This class is used by the assembly line (rscTask) to wrap an rscConnector object and provide additional functionality over the underlying rscConnector object. All attribute mapping, hook handling is performed by this class.

The underlying rscConnector object is exposed as a property called connector.


Field Summary
 boolean accumulateDupEntries
          This governs wether multiple lookups are combined into one entry or not.
 com.architech.connector.rscConnectorInterface connector
          This is the connector we are working with
 com.architech.connector.rscConnectorInterface input_connector
          This is the input_connector provided as a parameter (to the assembly line)
 com.architech.rsStats stats
          This is the statistics object for the connector
 java.lang.Object value
          This is the "ret.value" object returned by the attribute map
 
Constructor Summary
rscTaskComponent()
           
rscTaskComponent(com.architech.TaskInterface parent, java.lang.String name, java.util.TreeMap config, com.architech.connector.rscConnectorInterface conn)
          Constructor
 
Method Summary
 void add(Entry meta)
           
 void close()
          This method closes the connector (connector.terminate()) and calls the before/after close hooks.
 void debug(java.lang.String msg)
           
 void delete(Entry meta)
           
 void deleteEntry(Entry meta)
           
 void dumpEntry(Entry meta)
           
 void expandParameters(com.architech.config.rsConfiguration cf)
           
 java.lang.Object getConfig(java.lang.String param)
          This method returns the configuration value for parameter param.
 java.lang.Object getConnectorParam(java.lang.String param)
          This method returns the configuration value for the connector's parameter.
 boolean getDebug()
          This method returns the the debug mode flag.
 int getDuplicateEntryCount()
           
 Entry getLastReadEntry()
          This method returns the last entry read from the connector.
 java.lang.String getName()
          This method returns the name assigned to the connector by the assembly line.
 Entry getnext()
          The method returns the next entry from the connector.
 Entry getNextDuplicateEntry()
           
 com.architech.rsStats getStats()
           
 int getType()
          This method returns the mode in which we are executing (e.g.
 int handleException(java.lang.String oper, java.lang.Exception e, Entry meta)
           
 void initialize()
          This method initializes the underlying connnector and registers the script beans in the scriptEngine context.
 boolean isEnabled()
           
 boolean isExceptionFatal(java.lang.Exception e)
           
 void logmsg(java.lang.String msg)
           
 Entry lookup(Entry meta)
          The method is called to lookup an entry using the configured Link Criteria.
 Entry lookup(java.lang.String attribute, java.lang.String value)
          The method is called to lookup an entry using exact matching for attribute and value.
 void modify(Entry old, Entry meta)
           
 void pushback(Entry entry)
          This method pushes an entry back to the connector.
 void setDebug(boolean debug)
          This method sets the the debug mode flag.
 void setDuplicateEntryCount(int maxdup)
           
 void showDebug(java.lang.String str, java.lang.String oper, Entry work, Entry conn)
           
 boolean trigger(java.lang.String oper)
           
 boolean trigger(java.lang.String oper, Entry work, Entry conn)
           
 void update(Entry meta)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

input_connector

public com.architech.connector.rscConnectorInterface input_connector
This is the input_connector provided as a parameter (to the assembly line)

connector

public com.architech.connector.rscConnectorInterface connector
This is the connector we are working with

stats

public com.architech.rsStats stats
This is the statistics object for the connector

value

public java.lang.Object value
This is the "ret.value" object returned by the attribute map

accumulateDupEntries

public boolean accumulateDupEntries
This governs wether multiple lookups are combined into one entry or not.
Constructor Detail

rscTaskComponent

public rscTaskComponent(com.architech.TaskInterface parent,
                        java.lang.String name,
                        java.util.TreeMap config,
                        com.architech.connector.rscConnectorInterface conn)
                 throws java.lang.Exception
Constructor

rscTaskComponent

public rscTaskComponent()
Method Detail

getName

public java.lang.String getName()
This method returns the name assigned to the connector by the assembly line.
Returns:
The name of this connector (in scripting terms)

getConfig

public java.lang.Object getConfig(java.lang.String param)
This method returns the configuration value for parameter param.
Parameters:
param - The parameter name
Returns:
The object associated with parameter name

getConnectorParam

public java.lang.Object getConnectorParam(java.lang.String param)
This method returns the configuration value for the connector's parameter.
Parameters:
param - The parameter name
Returns:
The object associated with parameter name

getDebug

public boolean getDebug()
This method returns the the debug mode flag.
Returns:
True if debug is enabled, false otherwise

setDebug

public void setDebug(boolean debug)
This method sets the the debug mode flag.
Parameters:
debug - True to enable debug, false to disable

close

public void close()
This method closes the connector (connector.terminate()) and calls the before/after close hooks.

getType

public int getType()
This method returns the mode in which we are executing (e.g. Iterator, update etc..). public final static int TYPE_ITERATOR = 0; public final static int TYPE_UPDATE = 1; public final static int TYPE_LOOKUP = 2; public final static int TYPE_DELETE = 3; public final static int TYPE_ADDONLY = 4; public final static int TYPE_PASSIVE = 5;
Returns:
The integer value corresponding to the execution mode

initialize

public void initialize()
                throws java.lang.Exception
This method initializes the underlying connnector and registers the script beans in the scriptEngine context.

getLastReadEntry

public Entry getLastReadEntry()
This method returns the last entry read from the connector.
Returns:
The last input entry

pushback

public void pushback(Entry entry)
This method pushes an entry back to the connector. The entry is returned the next time connector.getNextEntry() is called.

getnext

public Entry getnext()
              throws java.lang.Exception
The method returns the next entry from the connector. It is called by the assembly line if we are working in Iterator mode.
Returns:
The next input entry or null if there are no more entries

lookup

public Entry lookup(java.lang.String attribute,
                    java.lang.String value)
             throws java.lang.Exception
The method is called to lookup an entry using exact matching for attribute and value.
Parameters:
attribute - The attribute name to search
value - The attribute value
Returns:
The entry found or null if no entries or more than one entry was found.

lookup

public Entry lookup(Entry meta)
             throws java.lang.Exception
The method is called to lookup an entry using the configured Link Criteria. The link criteria is applied using meta as source for variable substitution. If you allow duplicate entries by configuration, the method will return null only when no entries have been found.
Parameters:
meta - The entry object providing values for variable substitution.
Returns:
The entry found or null if no entries or more than one entry was found.

deleteEntry

public void deleteEntry(Entry meta)
                 throws java.lang.Exception

delete

public void delete(Entry meta)
            throws java.lang.Exception

update

public void update(Entry meta)
            throws java.lang.Exception

modify

public void modify(Entry old,
                   Entry meta)
            throws java.lang.Exception

add

public void add(Entry meta)
         throws java.lang.Exception

dumpEntry

public void dumpEntry(Entry meta)
               throws java.lang.Exception

getStats

public com.architech.rsStats getStats()

logmsg

public void logmsg(java.lang.String msg)

debug

public void debug(java.lang.String msg)

isExceptionFatal

public boolean isExceptionFatal(java.lang.Exception e)

handleException

public int handleException(java.lang.String oper,
                           java.lang.Exception e,
                           Entry meta)
                    throws java.lang.Exception

showDebug

public void showDebug(java.lang.String str,
                      java.lang.String oper,
                      Entry work,
                      Entry conn)
               throws java.lang.Exception

trigger

public boolean trigger(java.lang.String oper,
                       Entry work,
                       Entry conn)
                throws java.lang.Exception

trigger

public boolean trigger(java.lang.String oper)
                throws java.lang.Exception

setDuplicateEntryCount

public void setDuplicateEntryCount(int maxdup)

getDuplicateEntryCount

public int getDuplicateEntryCount()

getNextDuplicateEntry

public Entry getNextDuplicateEntry()
                            throws java.lang.Exception

expandParameters

public void expandParameters(com.architech.config.rsConfiguration cf)
                      throws java.lang.Exception

isEnabled

public boolean isEnabled()


*
  Metamerge Integrator version 4.5 ©Copyright Metamerge AS 2000-2002 Last edited 2002-04-30 contact us