Modeler Extensions Framework
clemext.h File Reference

Go to the source code of this file.

Macros

#define CLEMEXT_API
 
#define CLEMEXT_OK   0u
 
#define CLEMEXT_ERR_MODULE_SPECIFIC   1u
 
#define CLEMEXT_ERR_INVALID_HANDLE   2u
 
#define CLEMEXT_ERR_INVALID_OPERATION   3u
 
#define CLEMEXT_ERR_NODE_TYPE_NOT_SUPPORTED   4u
 
#define CLEMEXT_ERR_XML   5u
 
#define CLEMEXT_ERR_NOT_CONFIGURED   6u
 
#define CLEMEXT_ERR_NOT_EXECUTABLE   7u
 
#define CLEMEXT_ERR_NOT_EXECUTING   8u
 
#define CLEMEXT_ERR_NO_DATA   9u
 
#define CLEMEXT_ERR_NO_SQL   10u
 
#define CLEMEXT_ERR_NO_ERROR_DETAIL   11u
 
#define CLEMEXT_ERR_INTERRUPTED   12u
 
#define CLEMEXT_ERR_INSUFFICIENT_BUFFER   13u
 
#define CLEMEXT_ERR_CALLBACK   14u
 
#define CLEMEXT_ERR_NOT_INITIALIZED   15u
 
#define CLEMEXT_ERR_NOT_IMPLEMENTED   16u
 
#define CLEMEXT_ERR_CANNOT_MATCH_KEY   17u
 
#define CLEMEXT_ERR_EXCEPTION_THROWN   18u
 
#define CLEMEXT_ERR_NOT_INTERACTIVE   19u
 
#define CLEMEXT_ERR_NOT_INTERACTING   20u
 
#define CLEMEXT_ERR_INVALID_REQUEST   21u
 
#define CLEMEXT_ERR_NO_REPLY   22u
 
#define CLEMEXT_ERR_REMOTE   23u
 
#define CLEMEXT_ERR_INSUFFICIENT_METADATA   24u
 
#define CLEMEXT_ERR_FILE_ACCESS_RESTRICTED   25u
 
#define CLEMEXT_ERR_JVM_ATTACH_FAILED   39u
 
#define CLEMEXT_ERR_JVM_DETACH_FAILED   41u
 
#define CLEMEXT_NODE_DATA_READER   0
 
#define CLEMEXT_NODE_DATA_WRITER   1
 
#define CLEMEXT_NODE_DATA_TRANSFORMER   2
 
#define CLEMEXT_NODE_MODEL_BUILDER   3
 
#define CLEMEXT_NODE_MODEL_APPLIER   4
 
#define CLEMEXT_NODE_DOCUMENT_BUILDER   5
 
#define CLEMEXT_MODE_QUERY   0
 
#define CLEMEXT_MODE_EXECUTE   1
 
#define CLEMEXT_FILEPATH_TYPE_DATA   0
 
#define CLEMEXT_FILEPATH_TYPE_PROGRAM   1
 

Typedefs

typedef unsigned CLEMEXTStatus
 
typedef int CLEMEXTErrorCode
 
typedef double CLEMEXTReal
 
typedef long long CLEMEXTInteger
 
typedef CLEMEXTInteger CLEMEXTTime
 
typedef CLEMEXTInteger CLEMEXTDate
 
typedef CLEMEXTInteger CLEMEXTDatetime
 

Functions

CLEMEXT_API CLEMEXTStatus clemext_initialise (CLEMEXTHostHandle host, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_cleanup (CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_getModuleInformation (char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_create_peer (CLEMEXTNodeHandle node, int nodeType, const char *nodeId, CLEMEXTPeerHandle *peer, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_destroy_peer (CLEMEXTPeerHandle peer, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_configure (CLEMEXTPeerHandle peer, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_getDataModel (CLEMEXTPeerHandle peer, int mode, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_getExecutionRequirements (CLEMEXTPeerHandle peer, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_getCatalogueInformation (CLEMEXTPeerHandle peer, const char *catalogId, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_beginExecution (CLEMEXTPeerHandle peer, CLEMEXTIteratorHandle iterator, CLEMEXTProgressHandle listener, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_endExecution (CLEMEXTPeerHandle peer, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_cancelExecution (CLEMEXTPeerHandle peer, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_nextRecord (CLEMEXTPeerHandle peer, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_getRecordValue (CLEMEXTPeerHandle peer, size_t index, void **value, size_t *value_length, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_getSQLGeneration (CLEMEXTPeerHandle peer, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_getErrorDetail (CLEMEXTPeerHandle peer, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_beginInteraction (CLEMEXTPeerHandle peer, CLEMEXTChannelHandle channel, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_endInteraction (CLEMEXTPeerHandle peer, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_request (CLEMEXTPeerHandle peer, const char *request, size_t request_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_getRequestReply (CLEMEXTPeerHandle peer, char *reply_buffer, size_t reply_buffer_size, size_t *reply_data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_getPsmControlInformation (CLEMEXTPeerHandle peer, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_psmMerge (CLEMEXTPeerHandle peer, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_host_getHostInformation (CLEMEXTHostHandle host, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_node_getNodeInformation (CLEMEXTNodeHandle node, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_node_getParameters (CLEMEXTNodeHandle node, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_node_getDataModel (CLEMEXTNodeHandle node, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_node_getOutputDataModel (CLEMEXTNodeHandle node, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_node_getSQLGeneration (CLEMEXTNodeHandle node, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_node_getPassword (CLEMEXTNodeHandle node, const char *passwordId, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_node_getFilePath (CLEMEXTNodeHandle node, const char *fileId, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_node_expandFilePath (CLEMEXTNodeHandle node, const char *path, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_node_expandFilePathExt (CLEMEXTNodeHandle node, const char *path, unsigned int path_type, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_iterator_nextRecord (CLEMEXTIteratorHandle iterator, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_iterator_getRecordValue (CLEMEXTIteratorHandle iterator, size_t index, void **value, size_t *value_length, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_iterator_rewind (CLEMEXTIteratorHandle iterator, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_progress_report (CLEMEXTProgressHandle progress, const char *report, size_t report_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_channel_send (CLEMEXTChannelHandle channel, const char *message, size_t message_size, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_node_getPsmMergeInformation (CLEMEXTNodeHandle node, char *buffer, size_t buffer_size, size_t *data_size, CLEMEXTErrorCode *errorCode)
 
void clemext_host_trace (CLEMEXTHostHandle host, const char *text)
 
CLEMEXTStatus clemext_host_createNewDocument (CLEMEXTHostHandle host, const char *root_element_name, CLEMEXTXMLHandle *doc)
 
CLEMEXTStatus clemext_host_createDocumentFromContents (CLEMEXTHostHandle host, const char *contents, CLEMEXTXMLHandle *doc)
 
CLEMEXTStatus clemext_xml_disposeDocument (CLEMEXTXMLHandle doc)
 
CLEMEXTStatus clemext_xml_doc2string (CLEMEXTXMLHandle xml, char *buffer, size_t buffer_size, size_t *data_size)
 
CLEMEXTStatus clemext_xml_getName (CLEMEXTXMLHandle xml, char *buffer, size_t buffer_size, size_t *data_size)
 
CLEMEXTStatus clemext_xml_getAttribute (CLEMEXTXMLHandle xml, const char *name, char *buffer, size_t buffer_size, size_t *data_size)
 
CLEMEXTStatus clemext_xml_hasAttribute (CLEMEXTXMLHandle xml, const char *name, int *result)
 
CLEMEXTStatus clemext_xml_getElementIterator (CLEMEXTXMLHandle xml, const char *name, CLEMEXTXMLIteratorHandle *iterator)
 
CLEMEXTStatus clemext_xml_getTextIterator (CLEMEXTXMLHandle xml, CLEMEXTXMLIteratorHandle *iterator)
 
CLEMEXTStatus clemext_xml_addAttribute (CLEMEXTXMLHandle xml, const char *attribute_name, const char *attribute_value)
 
CLEMEXTStatus clemext_xml_removeAttribute (CLEMEXTXMLHandle xml, const char *attribute_name)
 
CLEMEXTStatus clemext_xml_addText (CLEMEXTXMLHandle xml, const char *data)
 
CLEMEXTStatus clemext_xml_addElement (CLEMEXTXMLHandle xml, const char *element_name, void **new_element)
 
CLEMEXTStatus clemext_xmliterator_hasMoreItems (CLEMEXTXMLIteratorHandle iterator, int *result)
 
CLEMEXTStatus clemext_xmliterator_nextItem (CLEMEXTXMLIteratorHandle iterator, void **item)
 
CLEMEXTStatus clemext_xmliterator_deleteCurrentItem (CLEMEXTXMLIteratorHandle iterator)
 
CLEMEXTStatus clemext_xmliterator_close (CLEMEXTXMLIteratorHandle iterator)
 
CLEMEXT_API CLEMEXTStatus clemext_peer_call (CLEMEXTPeerHandle peer, const char *fnName, void **in_buffers, void ***out_buffers, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_node_attachJVM (CLEMEXTNodeHandle node, void **jni_env, const char *options, CLEMEXTErrorCode *errorCode)
 
CLEMEXTStatus clemext_node_detachJVM (CLEMEXTNodeHandle node, void *jni_env, CLEMEXTErrorCode *errorCode)
 

Macro Definition Documentation

#define CLEMEXT_API

Definition at line 34 of file clemext.h.

#define CLEMEXT_MODE_EXECUTE   1

Definition at line 96 of file clemext.h.

#define CLEMEXT_MODE_QUERY   0

Definition at line 95 of file clemext.h.

Typedef Documentation

typedef int CLEMEXTErrorCode

Module-Specific Error Codes

Definition at line 77 of file clemext.h.