#include <Module.h>

Inheritance diagram for te::ado::Module:

Public Member Functions
const PluginInfo &	getInfo () const
	It return the information associated to the plugin. More...

bool	isStarted () const
	It tells if the plugin was started or not. More...

bool	operator< (const AbstractPlugin &rhs) const
	This overloaded operator can be used to index the plugin in a set. More...

Initializer Methods
Constructor/Destructor.
	Module (const te::plugin::PluginInfo &pluginInfo)
	It creates a new C++ module. More...

	~Module ()
	Destructor. More...

Re-Implmentation from Plugin Interface
Re-Implementation from Plugin Interface.
void	startup ()
	This method will be called by TerraLib to startup some plugin's functionality. More...

void	shutdown ()
	This method will be called by TerraLib to shutdown plugin's functionality. More...

Static Public Attributes
static const std::string	sm_booleanTypeName
	The string literal representation for the boolean type. More...

static const std::string	sm_byteArrayTypeName
	The string literal representation for the byte array type. More...

static const std::string	sm_charTypeName
	The string literal representation for the char type. More...

static const std::string	sm_dateTypeName
	The string literal representation for the date type. More...

static const std::string	sm_doubleTypeName
	The string literal representation for the double type. More...

static const std::string	sm_floatTypeName
	The string literal representation for the float type. More...

static const std::string	sm_geometryCollectionMTypeName
	The string literal representation for ADO geometry collection with m geometry type. More...

static const std::string	sm_geometryCollectionTypeName
	The string literal representation for ADO geometry collection geometry type. More...

static const std::string	sm_geometryTypeName
	The string literal representation for ADO base geometry type. More...

static const std::string	sm_int2TypeName
	The string literal representation for the int2 type. More...

static const std::string	sm_int8TypeName
	The string literal representation for the int8 type. More...

static const std::string	sm_intTypeName
	The string literal representation for the int type. More...

static const std::string	sm_lineStringMTypeName
	The string literal representation for ADO line string with m geometry type. More...

static const std::string	sm_lineStringTypeName
	The string literal representation for ADO line string geometry type. More...

static const std::string	sm_multiLineStringMTypeName
	The string literal representation for ADO multi-linestring with m geometry type. More...

static const std::string	sm_multiLineStringTypeName
	The string literal representation for ADO multi-linestring geometry type. More...

static const std::string	sm_multiPointMTypeName
	The string literal representation for ADO multi-point with m geometry type. More...

static const std::string	sm_multiPointTypeName
	The string literal representation for ADO multi-point geometry type. More...

static const std::string	sm_multiPolygonMTypeName
	The string literal representation for ADO multi-polygon with m geometry type. More...

static const std::string	sm_multiPolygonTypeName
	The string literal representation for ADO multi-polygon geometry type. More...

static const std::string	sm_numericTypeName
	The string literal representation for the numeric type. More...

static const std::string	sm_pointMTypeName
	The string literal representation for ADO point geometry type. More...

static const std::string	sm_pointTypeName
	The string literal representation for ADO point geometry type. More...

static const std::string	sm_polygonMTypeName
	The string literal representation for ADO polygon with m geometry type. More...

static const std::string	sm_polygonTypeName
	The string literal representation for ADO polygon geometry type. More...

static const std::string	sm_stringTypeName
	The string literal representation for the string type. More...

static const std::string	sm_timeStampTypeName
	The string literal representation for the time stamp type. More...

static const std::string	sm_timeStampTZTypeName
	The string literal representation for the time stamp with time zone type. More...

static const std::string	sm_timeTypeName
	The string literal representation for the time type. More...

static const std::string	sm_timeTZTypeName
	The string literal representation for the time type. More...

static const std::string	sm_unknownTypeName
	The string literal representation for the unknown type. More...

static const std::string	sm_varcharTypeName
	The string literal representation for the varchar type. More...

Protected Attributes
bool	m_initialized
	A flag that indicates if the plugin was started or not. More...

PluginInfo	m_pluginInfo
	Information about the plugin. More...

Detailed Description

Definition at line 44 of file Module.h.

Constructor & Destructor Documentation

te::ado::Module::Module ( const te::plugin::PluginInfo & pluginInfo )

It creates a new C++ module.

Definition at line 42 of file Module.cpp.

te::ado::Module::~Module ( )

Destructor.

Definition at line 47 of file Module.cpp.

Member Function Documentation

const te::plugin::PluginInfo & te::plugin::Plugin::getInfo ( ) const

virtualinherited

It return the information associated to the plugin.

Returns: The information associated to the plugin.

Implements te::plugin::AbstractPlugin.

Definition at line 29 of file Plugin.cpp.

References te::plugin::Plugin::m_pluginInfo.

bool te::plugin::Plugin::isStarted ( ) const

virtualinherited

It tells if the plugin was started or not.

Returns: True if the plugin is started and false otherwise (it is shutdown).

Implements te::plugin::AbstractPlugin.

Definition at line 34 of file Plugin.cpp.

bool te::plugin::AbstractPlugin::operator< ( const AbstractPlugin & rhs ) const

inherited

This overloaded operator can be used to index the plugin in a set.

Parameters

rhs	The right-hand-side plugin.

Returns: True if this plugin name is lexcographical less than the rhs plugin name.

Definition at line 38 of file AbstractPlugin.cpp.

References te::plugin::AbstractPlugin::getInfo().

void te::ado::Module::shutdown ( )

virtual

This method will be called by TerraLib to shutdown plugin's functionality.

Exceptions

Exception It throws an exception if the plugin can not be shutdown.

Reimplemented from te::plugin::Plugin.

Definition at line 72 of file Module.cpp.

References ADO_DRIVER_IDENTIFIER, te::common::Singleton< DataSourceManager >::getInstance(), te::da::DataSourceFactory::remove(), TE_LOG_TRACE, and TE_TR.

void te::ado::Module::startup ( )

virtual

This method will be called by TerraLib to startup some plugin's functionality.

Exceptions

Exception It throws an exception if the plugin can not be started.

Reimplemented from te::plugin::Plugin.

Definition at line 51 of file Module.cpp.

References te::da::DataSourceFactory::add(), te::ado::Build(), te::common::FindInTerraLibPath(), te::serialize::xml::Read(), te::ado::Globals::sm_capabilities, te::ado::Globals::sm_queryDialect, TE_LOG_TRACE, and TE_TR.

Member Data Documentation

bool te::plugin::Plugin::m_initialized

protectedinherited

A flag that indicates if the plugin was started or not.

Definition at line 79 of file Plugin.h.

PluginInfo te::plugin::Plugin::m_pluginInfo

protectedinherited

Information about the plugin.

Definition at line 78 of file Plugin.h.

Referenced by te::plugin::Plugin::getInfo().

const std::string te::ado::Module::sm_booleanTypeName

static

The string literal representation for the boolean type.

Definition at line 94 of file Module.h.

const std::string te::ado::Module::sm_byteArrayTypeName

static

The string literal representation for the byte array type.

Definition at line 98 of file Module.h.

const std::string te::ado::Module::sm_charTypeName

static

The string literal representation for the char type.

Definition at line 95 of file Module.h.

const std::string te::ado::Module::sm_dateTypeName

static

The string literal representation for the date type.

Definition at line 87 of file Module.h.

const std::string te::ado::Module::sm_doubleTypeName

static

The string literal representation for the double type.

Definition at line 93 of file Module.h.

const std::string te::ado::Module::sm_floatTypeName

static

The string literal representation for the float type.

Definition at line 92 of file Module.h.

const std::string te::ado::Module::sm_geometryCollectionMTypeName

static

The string literal representation for ADO geometry collection with m geometry type.

Definition at line 106 of file Module.h.

const std::string te::ado::Module::sm_geometryCollectionTypeName

static

The string literal representation for ADO geometry collection geometry type.

Definition at line 105 of file Module.h.

const std::string te::ado::Module::sm_geometryTypeName

static

The string literal representation for ADO base geometry type.

Definition at line 113 of file Module.h.

const std::string te::ado::Module::sm_int2TypeName

static

The string literal representation for the int2 type.

Definition at line 83 of file Module.h.

const std::string te::ado::Module::sm_int8TypeName

static

The string literal representation for the int8 type.

Definition at line 85 of file Module.h.

const std::string te::ado::Module::sm_intTypeName

static

The string literal representation for the int type.

Definition at line 84 of file Module.h.

const std::string te::ado::Module::sm_lineStringMTypeName

static

The string literal representation for ADO line string with m geometry type.

Definition at line 102 of file Module.h.

const std::string te::ado::Module::sm_lineStringTypeName

static

The string literal representation for ADO line string geometry type.

Definition at line 101 of file Module.h.

const std::string te::ado::Module::sm_multiLineStringMTypeName

static

The string literal representation for ADO multi-linestring with m geometry type.

Definition at line 110 of file Module.h.

const std::string te::ado::Module::sm_multiLineStringTypeName

static

The string literal representation for ADO multi-linestring geometry type.

Definition at line 109 of file Module.h.

const std::string te::ado::Module::sm_multiPointMTypeName

static

The string literal representation for ADO multi-point with m geometry type.

Definition at line 108 of file Module.h.

const std::string te::ado::Module::sm_multiPointTypeName

static

The string literal representation for ADO multi-point geometry type.

Definition at line 107 of file Module.h.

const std::string te::ado::Module::sm_multiPolygonMTypeName

static

The string literal representation for ADO multi-polygon with m geometry type.

Definition at line 112 of file Module.h.

const std::string te::ado::Module::sm_multiPolygonTypeName

static

The string literal representation for ADO multi-polygon geometry type.

Definition at line 111 of file Module.h.

const std::string te::ado::Module::sm_numericTypeName

static

The string literal representation for the numeric type.

Definition at line 86 of file Module.h.

const std::string te::ado::Module::sm_pointMTypeName

static

The string literal representation for ADO point geometry type.

Definition at line 100 of file Module.h.

const std::string te::ado::Module::sm_pointTypeName

static

The string literal representation for ADO point geometry type.

Definition at line 99 of file Module.h.

const std::string te::ado::Module::sm_polygonMTypeName

static

The string literal representation for ADO polygon with m geometry type.

Definition at line 104 of file Module.h.

const std::string te::ado::Module::sm_polygonTypeName

static

The string literal representation for ADO polygon geometry type.

Definition at line 103 of file Module.h.

const std::string te::ado::Module::sm_stringTypeName

static

The string literal representation for the string type.

Definition at line 97 of file Module.h.

const std::string te::ado::Module::sm_timeStampTypeName

static

The string literal representation for the time stamp type.

Definition at line 90 of file Module.h.

const std::string te::ado::Module::sm_timeStampTZTypeName

static

The string literal representation for the time stamp with time zone type.

Definition at line 91 of file Module.h.

const std::string te::ado::Module::sm_timeTypeName

static

The string literal representation for the time type.

Definition at line 88 of file Module.h.

const std::string te::ado::Module::sm_timeTZTypeName

static

The string literal representation for the time type.

Definition at line 89 of file Module.h.

const std::string te::ado::Module::sm_unknownTypeName

static

The string literal representation for the unknown type.

Definition at line 82 of file Module.h.

const std::string te::ado::Module::sm_varcharTypeName

static

The string literal representation for the varchar type.

Definition at line 96 of file Module.h.

The documentation for this class was generated from the following files:

C:/TL5_2015_release/terralib5/src/terralib/ado/Module.h
C:/TL5_2015_release/terralib5/src/terralib/ado/Module.cpp

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation