|
|
com.architech.connector
|
Field Summary | |
static String |
PROPERTY_MESSAGE
|
static String |
PROPERTY_READER
|
static String |
PROPERTY_WRITER
|
Fields inherited from interface com.architech.connector.rscConnectorInterface |
RCS_ADD, RCS_ALL, RCS_DELETE, RCS_HIERARCHICALSEARCH, RCS_MODIFY, RCS_NONE, RCS_SEARCH |
Constructor Summary | |
rscConnector()
Default constructor. |
Method Summary | |
void |
abort(String errmsg)
|
void |
addFindEntry(Object entry)
Adds an entry to the list of duplicate entries found. |
void |
clearFindEntries()
Removes all entries from the duplicate entry list. |
void |
debug(String msg)
Log a message to the connector's log if the debug flag is set. |
boolean |
debugMode()
Returns whether debug mode is set or not. |
void |
deleteEntry(Entry entry,
rscSearchCriteria search)
Deletes an existing entry. |
Entry |
findEntry(Object key,
Object value)
Locates an entry based on a key/value pair. |
Entry |
findEntry(rscSearchCriteria search)
Finds an existing entry. |
Boolean |
getBoolean(Object p1)
Get boolean returns the value of a config parameter as boolean |
int |
getCapabilities()
Returns the connector's capabilities flag. |
static Object |
getClassInstance(String className)
Returns a class instance of the specified classname |
TreeMap |
getConfiguration()
Returns the current configuration for this connector as a TreeMap. |
int |
getFindEntryCount()
Returns the number of duplicate entries in the list. |
com.architech.rsLog |
getLog()
Returns the current log object. |
int |
getMaxDuplicateEntries()
Returns the current number of duplicate entries buffered up by the connector. |
com.architech.config.rsConfiguration |
getMyConfiguration()
Returns the current configuration for this connector |
String |
getName()
Returns the name for this connector. |
Entry |
getNextFindEntry()
Returns the next entry from the list of duplicate entries found. |
String |
getParam(String param)
Returns the value of param as a java.lang.String object. |
String[][] |
getParameters()
Returns an array of parameter names and descriptions for the connector's set of parameters. |
com.architech.parser.rspParserInterface |
getParser()
Returns the parser interface used by this connector. |
Object |
getProperty(Object p1)
Return a connector property. |
Entry |
getPushbackEntry()
Returns the pushed back entry for the connector. |
com.architech.RSInterface |
getRSInterface()
Returns the current RSInterface object in use by this connector. |
boolean |
hasCapabability(int capability)
Checks if the connector is capable of a specific operation |
boolean |
hasConfigValue(Object p1)
Return true if we have a configuration value for configName. |
boolean |
hasParser()
Check if the configuration includes a parser. |
void |
initialize(Object o)
Initialize the connector. |
void |
initParser(Object is,
Object os)
Initialize the connector's parser with input and output streams. |
boolean |
isExceptionFatal(Exception e)
Returns true if the exception is considered to be fatal. |
void |
loadParser(String className)
Loads the parser this connector will use. |
void |
logmsg(String msg)
Log a message to the connector's log. |
void |
modEntry(Entry entry,
rscSearchCriteria search)
Modifies an existing entry. |
void |
pushback(Entry e)
Make an entry the next entry to be iterated from the connector. |
void |
putEntry(Entry entry)
Adds a new entry. |
Object |
querySchema(Object source)
This function translates to whatever means a connector has to discover schema for a connection. |
Vector |
queryTables()
This function translates to whatever means a connector have to discover "tables" for a connection. |
void |
registerScriptBeans(com.architech.script.scriptEngine se)
This method is called to register specific objects in the script context. |
void |
setCapabilities(int capabilities)
Sets the connectors capabilities to capabilities |
void |
setConfiguration(Object config)
Sets the configuration for use by this connector. |
void |
setLog(com.architech.rsLog logger)
Sets the log object to use for logging messages |
void |
setMaxDuplicateEntries(int mde)
Sets the maximum number of duplicate entries to buffer up. |
void |
setName(String name)
Set the name for the connector. |
void |
setParam(String param,
String value)
Adds or replaces a connnector configuration parameter. |
void |
setParentConfiguration(com.architech.config.rsConfiguration parentConfig)
Sets the parent configuration from which this connector inherits configuration data. |
void |
setParser(com.architech.parser.rspParserInterface parser)
Sets the connector's parser. |
void |
setProperty(Object p1,
Object p2)
Set connector property. |
void |
setRSInterface(com.architech.RSInterface rsi)
Sets the RSInterface for this connector to use. |
void |
terminate()
Terminate the connector. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.architech.connector.rscConnectorInterface |
getNextEntry, selectEntries |
Methods inherited from interface com.architech.VersionInfoInterface |
getVersion |
Field Detail |
public static final String PROPERTY_MESSAGE
public static final String PROPERTY_READER
public static final String PROPERTY_WRITER
Constructor Detail |
public rscConnector()
Method Detail |
public String[][] getParameters()
getParameters
in interface rscConnectorInterface
public void setLog(com.architech.rsLog logger)
setLog
in interface rscConnectorInterface
logger
- The log objectrscConnector.logmsg
public com.architech.rsLog getLog()
rsLog
public Boolean getBoolean(Object p1)
public boolean hasConfigValue(Object p1)
public void setMaxDuplicateEntries(int mde)
setMaxDuplicateEntries
in interface rscConnectorInterface
maxDupEntries
- The maximum number of entries to buffer uppublic int getMaxDuplicateEntries()
getMaxDuplicateEntries
in interface rscConnectorInterface
public Entry getPushbackEntry()
getPushbackEntry
in interface rscConnectorInterface
public void pushback(Entry e)
pushback
in interface rscConnectorInterface
entry
- The entry to be returned at the next getnext callpublic void logmsg(String msg)
msg
- The message to write to the logpublic void debug(String msg)
msg
- The message to write to the logpublic void setName(String name)
setName
in interface rscConnectorInterface
name
- The name for the connectorpublic String getName()
getName
in interface rscConnectorInterface
public int getCapabilities()
getCapabilities
in interface rscConnectorInterface
public void setCapabilities(int capabilities)
setCapabilities
in interface rscConnectorInterface
capabilities
- The capabilities bitspublic boolean hasCapabability(int capability)
hasCapabability
in interface rscConnectorInterface
capability
- The capability to checkpublic void setParam(String param, String value)
setParam
in interface rscConnectorInterface
param
- The parameter namevalue
- The parameter valuepublic String getParam(String param)
getParam
in interface rscConnectorInterface
param
- The connector configuration parameter namepublic void setParentConfiguration(com.architech.config.rsConfiguration parentConfig)
setParentConfiguration
in interface rscConnectorInterface
parentConfig
- The configuration object to inherit from.public void setConfiguration(Object config)
setConfiguration
in interface rscConnectorInterface
config
- The configuration object (rsConfiguration or TreeMap)public com.architech.config.rsConfiguration getMyConfiguration()
public TreeMap getConfiguration()
getConfiguration
in interface rscConnectorInterface
public void setRSInterface(com.architech.RSInterface rsi)
setRSInterface
in interface rscConnectorInterface
rsi
- The RSInterface objectpublic com.architech.RSInterface getRSInterface()
public boolean debugMode()
public boolean isExceptionFatal(Exception e)
isExceptionFatal
in interface rscConnectorInterface
e
- The exception objectpublic static Object getClassInstance(String className) throws Exception
className
- The fully qualified Java class nameAny
- exception thrown by the class loaderpublic void abort(String errmsg)
abort
in interface rscConnectorInterface
public void loadParser(String className) throws Exception
className
- The java class name for the parser to useAny
- exception thrown by the class loaderpublic void initialize(Object o) throws Exception
initialize
in interface rscConnectorInterface
o
- User provided parameterpublic boolean hasParser()
public void initParser(Object is, Object os) throws Exception
is
- The input object.os
- the output object.Any
- exception thrown by the parserrscConnector.loadParser
public void setParser(com.architech.parser.rspParserInterface parser) throws IOException
parser
- The parser interface to usepublic com.architech.parser.rspParserInterface getParser()
public void terminate()
terminate
in interface rscConnectorInterface
public void modEntry(Entry entry, rscSearchCriteria search) throws Exception
modEntry
in interface rscConnectorInterface
entry
- The entry datasearch
- The search criteria used to locate the entry to be modifiedAny
- exceptions thrown by the connector's underlying classespublic void deleteEntry(Entry entry, rscSearchCriteria search) throws Exception
deleteEntry
in interface rscConnectorInterface
entry
- The entry datasearch
- The search criteria used to locate the entry to be modifiedAny
- exceptions thrown by the connector's underlying classespublic Entry findEntry(rscSearchCriteria search) throws Exception
findEntry
in interface rscConnectorInterface
search
- The search criteria used to locate the entry to be modifiedAny
- exceptions thrown by the connector's underlying classespublic void putEntry(Entry entry) throws Exception
putEntry
in interface rscConnectorInterface
entry
- The entry dataAny
- exceptions thrown by the connector's underlying classespublic Entry getNextFindEntry() throws Exception
getNextFindEntry
in interface rscConnectorInterface
Any
- exceptions thrown by the connector's underlying classespublic Entry findEntry(Object key, Object value)
key
- The attribute namevalue
- The attribute value matchpublic int getFindEntryCount()
getFindEntryCount
in interface rscConnectorInterface
public void clearFindEntries()
public void addFindEntry(Object entry)
entry
- The entry object to addpublic Object querySchema(Object source) throws Exception
Each Entry in the Vector returned should contain the following attributes:
Name | Value |
---|---|
name | The name of the column/attribute/field .... |
syntax | The syntax or expected value type |
size | If specified this will give the user a hint as to how long the field may be |
querySchema
in interface rscConnectorInterface
public Vector queryTables() throws Exception
Vector
public Object getProperty(Object p1)
p1
- The property namepublic void setProperty(Object p1, Object p2)
p1
- The property namep2
- The property valuepublic void registerScriptBeans(com.architech.script.scriptEngine se) throws Exception
registerScriptBeans
in interface rscConnectorInterface
se
- The script engine context
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
![]() |
|