TerraLib definition of a Theme. More...

#include <TeTheme.h>

Inheritance diagram for TeTheme:

Public Member Functions
	TeTheme (const string &name="", TeLayer layer=0, TeViewNode parent=0, const int &view=0, const int &id=0)
	Constructor.
	TeTheme (const TeViewNodeParams &params)
	Constructor.
	TeTheme (const TeTheme &other)
	Copy constructor.
	~TeTheme ()
	Destructor.
TeTheme &	operator= (const TeTheme &other)
	Assignment operator.
virtual TeViewNode *	clone ()
	Clones the object.
virtual void	setSpatialRest (TeBox &box, TeGeomRep rep=TeGEOMETRYNONE, TeSpatialRelation relation=TeWITHIN)
	Sets the spatial restriction to be a spatial relation with a box.
virtual void	setSpatialRest (TeGeometry *geom, TeGeomRep rep=TeGEOMETRYNONE, TeSpatialRelation relation=TeWITHIN)
	Sets the spatial restriction to be a spatial relation with a geometry.
virtual string	sqlWhereRestrictions (TeRepresentation *rep=0)
	Returns the clause WHERE derived from the combination of all restricitions (spatial, attribute and temporal)
virtual void	createRasterVisual (TeRaster *rst=0)
	Creates an appropriate visual presentation to the raster of the theme.
virtual bool	isUpdated ()
	Checks if the theme is update. If FALSE, the theme may be not be updated.
virtual void	updateThemeBox ()
	Refreshes the bounding box of a theme according to its representation.
virtual void	updateThemeBox (const TeBox &)
	Updates the bounding box of a theme (in the database)
virtual set< string >	getObjects (TeSelectedObjects selectedObjects=TeAll)
	Get the set of objects corresponding to the object selection criteria.
virtual set< string >	getObjects (const vector< string > &itemVec)
	Get the set of objects corresponding to the list of items.
virtual vector< string >	getItemVector (TeSelectedObjects selectedObjects)
	Get the set of items corresponding to the object selection criteria.
virtual vector< string >	getItemVector (const set< string > &oidSet)
	Get the set of items corresponding to the set of objects.
virtual bool	hasObjectsWithoutGeometries (TeGeomRep geomRep)
	Verifies if there are objects without geometries of a specific geometry representation.
virtual bool	removeObjectsWithoutGeometries (TeGeomRep geomRep)
	Removes the objects without geometries of a specific geometry representation.
virtual bool	save ()
	Save the the theme parameters in the database.
virtual unsigned int	getNumberOfObjects ()
	Get the number of objects acessible by this theme.
virtual bool	saveMetadata (TeDatabase *)
	Save the theme metadata in database. In this case, this metadata is saved by TeDatabase.
void	setUsingCollection (const bool &usingCollection)
	Tells if it necessary to build a collection.
Layer
Methods related to the layer that gives origin to this theme.
virtual int	layerId ()
	Returns the id of the source layer.
virtual void	layerId (int i)
	Sets the id of the source layer.
virtual void	layer (TeLayer *layer)
	Sets the layer that is the source of objects of the theme.
virtual TeLayer *	layer ()
	Returns a pointer to the layer from which the theme get its objects.
virtual TeProjection *	getThemeProjection ()
	Returns a pointer to a projection that is the spatial reference for the objects of this theme: same as of its layer.
Collection
Methods related to the materialization in the database of the theme as a collection of objects
virtual string	collectionTable ()
	Returns the name of a table used to store the ids of the objects belonging to the theme.
virtual void	collectionTable (const string &s)
	Sets the name of a table used to store the ids of the objects belonging to the theme.
virtual string	collectionAuxTable ()
	Returns the name of the collection auxiliary table.
virtual void	collectionAuxTable (string name)
	Sets the name of the collection auxiliary table.
virtual bool	generateLabelPositions (const std::string &objectId="")
	Generates a optimized position (x,y) in the spatial extention of each object to position label ou graphs.
virtual void	loadTablesJoin (const string &geomTable="")
	Fills the sqlGridJoin_ and sqlGridFrom_ statements according to the status of the database.
virtual string	sqlGridJoin ()
virtual string	sqlGridFrom (const string &geomTable="")
virtual bool	buildCollection (std::string objectId="", const bool &sincronize=true)
	Build the theme collection: materializes the selection described in the theme in a collection table.
virtual bool	createCollectionAuxTable ()
	Create the auxiliar collection table used to represent objects with multiple versions in time.
virtual bool	populateCollectionAux (std::string objectId="")
	Populate the auxiliar collection table used to represent objects with multiple versions in time.
Grouping
Methods related to grouping of objects of the theme.
virtual bool	buildGrouping (const TeGrouping &g, TeSelectedObjects selectedObjects=TeAll, vector< double > *dValuesVec=0)
	Save the grouping parameters in memory when there is no chronon.
virtual bool	buildGrouping (const TeGrouping &g, TeChronon chr, vector< map< string, string > > &mapObjValVec)
	Save the grouping parameters in memory when there is chronon.
virtual bool	saveGrouping (TeSelectedObjects selectedObjects=TeAll)
	Build the grouping and associate each object to its group in the collection table.
virtual bool	saveLegendInCollection (TeSelectedObjects selectedObjects=TeAll, std::string objectId="")
	Save the theme grouping legends in the collection table.
virtual void	setLegendsForObjects ()
	Set the legend id for each object of the theme.
virtual void	setOwnLegendsForObjects ()
	Set the own legend id for each object of the theme.
virtual bool	deleteGrouping ()
	Delete grouping.
Attribute Tables
A theme can use one or more attribute tables of the layer that gives its data. These methods are related to the manipulation of these tables.
virtual bool	loadThemeTables ()
	Loads the theme tables in the database.
virtual bool	addThemeTable (TeTable &table)
	Add a new attribute table to a theme.
virtual void	addThemeTable (string tableName)
	Add a new attribute table to a theme.
virtual bool	isThemeTable (int tableId)
	Verify if an attribute table is part of a theme.
virtual bool	isThemeTable (string tableName)
	Verify if an attribute table is part of a theme.
virtual TeAttrTableVector &	attrTables ()
	Returns the list of attribute tables used by this theme.
virtual bool	setAttTables (TeAttrTableVector &attrs)
	Sets the entire list of attribute tables used by this theme.
virtual bool	getAttTables (TeAttrTableVector &attrs, TeAttrTableType attType=TeAllAttrTypes)
	Returns a vector of attribute tables, of a specific type, used by this theme.
virtual bool	getTable (TeTable &table, const string tableName)
	Returns a representation of an attribute table given name.
virtual void	clearAttTableVector ()
	Clears the list of attribute tables used by this theme.
virtual bool	getTemporalTable (TeTable &table)
	Returns the temporal attribute table of the theme (TeEvent or TeFixedGeomDynAttr)
virtual bool	removeThemeTable (unsigned int index)
	Removes an attribute table from the list of tables of a theme.
virtual string	getTableName (const string &attrName)
	Returns the the name of an attribute table that contains a given attribute.
virtual string	getAttribute (unsigned int i)
virtual bool	isIndex (unsigned int i)
virtual TeAttributeList	sqlAttList ()
	Returns the list of attributes of theme tables.
virtual void	clearAttList ()
	Clears the list of attributes associated to the theme tables.
virtual TeAttributeList	sqlNumAttList ()
	Returns the list of numerical attributes of the theme tables.
virtual void	clearNumAttList ()
	Clears the list of numerical attributes associated to the theme tables.
virtual string	sqlJoin ()
	Returns a SQL JOIN statement to reach to all attribute tables used by this theme.
virtual string	sqlFrom ()
	Returns a SQL FROM CLAUSE that gives access to all attribute tables used by this theme.
virtual string &	sqlWhere ()
	Returns the string containing the SQL WHERE clause.
virtual vector< string > &	aliasVector ()
	Returns the alias vector of the names of the theme tables.
virtual void	loadAliasVector ()
	fill aliasVector_
virtual void	loadAttrLists ()
	Refresh list of attributes of all the theme tables.
Locate geometries
Returns the geometry(ies) of the theme given coordinate
virtual bool	locatePolygon (TeCoord2D &pt, TePolygon &polygon, const double &tol=0.0)
virtual bool	locatePolygonSet (TeCoord2D &pt, double tol, TePolygonSet &polygons)
virtual bool	locateLine (TeCoord2D &pt, TeLine2D &line, const double &tol=0.0)
virtual bool	locatePoint (TeCoord2D &pt, TePoint &point, const double &tol=0.0)
virtual bool	locateCell (TeCoord2D &pt, TeCell &c, const double &tol=0.0)
Protected Member Functions
virtual bool	createCollectionAuxTable (TeDatabase *db)
	Create the auxiliar collection table used to represent objects with multiple versions in time.
virtual bool	buildGrouping (TeDatabase db, const TeGrouping &g, TeSelectedObjects selectedObjects=TeAll, vector< double > dValuesVec=0)
	Save the grouping parameters in memory when there is no chronon.
virtual bool	buildGrouping (TeDatabase *db, const TeGrouping &g, TeChronon chr, vector< map< string, string > > &mapObjValVec)
	Save the grouping parameters in memory when there is chronon.
virtual bool	saveGrouping (TeDatabase *db, TeSelectedObjects selectedObjects=TeAll)
	Build the grouping and associate each object to its group in the collection table.
virtual bool	saveLegendInCollection (TeDatabase *db, TeSelectedObjects selectedObjects=TeAll, std::string objectId="")
	Save the theme grouping legends in the collection table.
virtual void	loadThemeTablesJoin ()
	Fill the sqlJoin_ and sqlFrom_.
virtual bool	populateCollection (std::string objectId="", const bool &sincronize=true)
	Populate the collection table based in the theme restrictions.
virtual bool	loadMetadata (TeDatabase *)
	Load the theme metadata from database. In this case, this metadata is loaded by TeDatabase.
virtual bool	eraseMetadata (TeDatabase *)
	Erase the theme metadata in database. In this case, this metadata is erased by TeDatabase.
virtual bool	beforeCopyThemeTo (TeAbstractTheme absThemeCopy, TeDatabase outputDatabase)
	Should be reimplemented to set all the parameters and pre-requisites necessaries to copy a theme to the given database. This method will be called before the theme is saved in the database.
virtual bool	afterCopyThemeTo (TeAbstractTheme absThemeCopy, TeDatabase outputDatabase)
	Should be reimplemented if some functions for the theme copy need to be done after the theme was saved on its new location. This method will be called after the theme is saved in the database.
Protected Attributes
TeAttrTableVector	attTableVector_
	list of attribute tables of the theme
TeAttributeList	sqlAttList_
	List containing all the attributes of the theme tables.
TeAttributeList	sqlNumAttList_
	List containing only the numeric attributes of the theme tables.
TeLayer *	layer_
	Pointer to the layer that gives origin to this theme.
int	layerId_
	Layer id.
string	collectionTable_
string	collectionAuxTable_
bool	useCollection_
string	sqlFrom_
	clause FROM: join with the theme tables and collection table
string	sqlJoin_
	clause SELECT and FROM: join with the theme tables and collection table
string	sqlWhere_
	string containing the WHERE clause
string	sqlGridFrom_
	clause FROM: join with the theme tables and auxiliar collection table
string	sqlGridJoin_
	clause SELECT and FROM: join with the theme tables and auxiliar collection table
vector< string >	aliasVector_
	vector of alias to the attribute tables that are used more than once

Detailed Description

TerraLib definition of a Theme.

: A TeTheme represents a collection of objects selected from a TeLayer. This selection is based on restrictions that can be non-spatial (e.g. POP > 10000), spatial (e.g. "inside box(0,0,100,100) or temporal. The most simple selection is "all" objects of a layer.

: A TeTheme contains the list of attribute tables of the layer used by a theme.

: A TeTheme contains the visual presentation parameters for the objects that contains, for all of its geometrical representations.

: A TeTheme can store the parameters associated to how to separate its objects in groups.

: A TeTheme can store parameters associated to the creation of individual graphs on its objects (e.g. pie bars that relate two or more of its attributes).

: A TeTheme store the range of scales within it should be visible.

See also:: TeView TeTable

Examples:: createSTElementSetFromTheme.cpp, createTheme.cpp, querierFromTheme.cpp, querierGroupChronon.cpp, querierGroupElement.cpp, querierGroupSpatialRest.cpp, querierWithSpatialRestBox.cpp, querierWithSpatialRestGeometry.cpp, rasterSlicing.cpp, and themeGrouping.cpp.

Constructor & Destructor Documentation

TeTheme::TeTheme	(	const string &	name = `""`,
		TeLayer *	layer = `0`,
		TeViewNode *	parent = `0`,
		const int &	view = `0`,
		const int &	id = `0`
	)

Constructor.

TeTheme::TeTheme ( const TeViewNodeParams & params )

Constructor.

TeTheme::TeTheme ( const TeTheme & other )

Copy constructor.

TeTheme::~TeTheme ( )

Destructor.

Member Function Documentation

bool TeTheme::addThemeTable ( TeTable & table ) [virtual]

Add a new attribute table to a theme.

Reimplemented in TeExternalTheme.

void TeTheme::addThemeTable ( string tableName ) [virtual]

Add a new attribute table to a theme.

Reimplemented in TeExternalTheme.

bool TeTheme::afterCopyThemeTo	(	TeAbstractTheme *	absThemeCopy,
		TeDatabase *	outputDatabase
	)		`[protected, virtual]`

Should be reimplemented if some functions for the theme copy need to be done after the theme was saved on its new location. This method will be called after the theme is saved in the database.

Reimplemented from TeAbstractTheme.

virtual vector<string>& TeTheme::aliasVector ( ) [inline, virtual]

Returns the alias vector of the names of the theme tables.

Reimplemented in TeExternalTheme.

virtual TeAttrTableVector& TeTheme::attrTables ( ) [inline, virtual]

Returns the list of attribute tables used by this theme.

Reimplemented in TeExternalTheme.

bool TeTheme::beforeCopyThemeTo	(	TeAbstractTheme *	absThemeCopy,
		TeDatabase *	outputDatabase
	)		`[protected, virtual]`

Should be reimplemented to set all the parameters and pre-requisites necessaries to copy a theme to the given database. This method will be called before the theme is saved in the database.

Reimplemented from TeAbstractTheme.

Reimplemented in TeExternalTheme.

bool TeTheme::buildCollection	(	std::string	objectId = `""`,
		const bool &	sincronize = `true`
	)		`[virtual]`

Build the theme collection: materializes the selection described in the theme in a collection table.

Examples:: createTheme.cpp.

bool TeTheme::buildGrouping	(	TeDatabase *	db,
		const TeGrouping &	g,
		TeSelectedObjects	selectedObjects = `TeAll`,
		vector< double > *	dValuesVec = `0`
	)		`[protected, virtual]`

Save the grouping parameters in memory when there is no chronon.

bool TeTheme::buildGrouping	(	TeDatabase *	db,
		const TeGrouping &	g,
		TeChronon	chr,
		vector< map< string, string > > &	mapObjValVec
	)		`[protected, virtual]`

Save the grouping parameters in memory when there is chronon.

bool TeTheme::buildGrouping	(	const TeGrouping &	g,
		TeSelectedObjects	selectedObjects = `TeAll`,
		vector< double > *	dValuesVec = `0`
	)		`[virtual]`

Save the grouping parameters in memory when there is no chronon.

bool TeTheme::getAttTables	(	TeAttrTableVector &	attrs,
		TeAttrTableType	attType = `TeAllAttrTypes`
	)		`[virtual]`

bool TeTheme::getTable	(	TeTable &	table,
		const string	tableName
	)		`[virtual]`

bool TeTheme::locateCell	(	TeCoord2D &	pt,
		TeCell &	c,
		const double &	tol = `0.0`
	)		`[virtual]`

bool TeTheme::locateLine	(	TeCoord2D &	pt,
		TeLine2D &	line,
		const double &	tol = `0.0`
	)		`[virtual]`

bool TeTheme::locatePoint	(	TeCoord2D &	pt,
		TePoint &	point,
		const double &	tol = `0.0`
	)		`[virtual]`

bool TeTheme::locatePolygon	(	TeCoord2D &	pt,
		TePolygon &	polygon,
		const double &	tol = `0.0`
	)		`[virtual]`

bool TeTheme::locatePolygonSet	(	TeCoord2D &	pt,
		double	tol,
		TePolygonSet &	polygons
	)		`[virtual]`

bool TeTheme::populateCollection	(	std::string	objectId = `""`,
		const bool &	sincronize = `true`
	)		`[protected, virtual]`

bool TeTheme::saveGrouping	(	TeDatabase *	db,
		TeSelectedObjects	selectedObjects = `TeAll`
	)		`[protected, virtual]`

bool TeTheme::saveLegendInCollection	(	TeDatabase *	db,
		TeSelectedObjects	selectedObjects = `TeAll`,
		std::string	objectId = `""`
	)		`[protected, virtual]`

void TeTheme::setSpatialRest	(	TeBox &	box,
		TeGeomRep	rep = `TeGEOMETRYNONE`,
		TeSpatialRelation	relation = `TeWITHIN`
	)		`[virtual]`

void TeTheme::setSpatialRest	(	TeGeometry *	geom,
		TeGeomRep	rep = `TeGEOMETRYNONE`,
		TeSpatialRelation	relation = `TeWITHIN`
	)		`[virtual]`

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation