#include <resource.h>

Inheritance diagram for Ilwis::Resource:

Public Member Functions
	Resource ()

	Resource (const Resource &resource)

	Resource (const QUrl &url, quint64 tp, bool isNew=true)

	Resource (const QString &name, quint64 tp, bool isNew=true)

	Resource (quint64 tp, const QUrl &url=INTERNAL_OBJECT)

	Resource (const QSqlRecord &rec)

void	setName (const QString &nm, bool adaptUrl=true)

QVariant	operator[] (const QString &property) const

bool	hasProperty (const QString &property) const

void	addProperty (const QString &key, const QVariant &value)

QUrl	url () const

void	setUrl (const QUrl &url)

QUrlQuery	urlQuery () const

bool	hasUrlQuery () const

QString	toLocalFile (bool relative=false) const

QUrl	container (int level=0) const

void	addContainer (const QUrl &url, int level=0)

quint64	size () const

QString	dimensions () const

IlwisTypes	ilwisType () const

IlwisTypes	extendedType () const

void	setIlwisType (IlwisTypes tp)

void	setExtendedType (IlwisTypes tp)

void	prepare ()

bool	store (QSqlQuery &queryItem, QSqlQuery &queryProperties) const

bool	isValid () const

bool	operator() (const Ilwis::Resource &resource)

void	setId (quint64 newid)

Resource	copy (quint64 id) const

bool	isRoot () const

Public Member Functions inherited from Ilwis::Identity
virtual void	setCode (const QString &code)
	sets the code for this instance More...

QString	code () const
	code returns the code of the identity. If no code is attached it will return sUNDEF ("?"). More...

quint64	id () const
	id returns a unsigned 64-bit number unique for the objects using the identity More...

virtual QString	name () const
	name returns the name of an object. All objects have names though names need not to be unique More...

void	setName (const QString &n)
	setName sets the name of an object. All objects have names though names need not to be unique More...

virtual QString	description () const

void	setDescription (const QString &desc)

Static Public Member Functions
static QString	toLocalFile (const QUrl &url, bool relative=false, const QString &ext=sUNDEF)

static bool	isRoot (const QString &txt)

Protected Member Functions
void	stringAsUrl (const QString &txt, IlwisTypes tp, bool isNew)

void	checkUrl (IlwisTypes tp)

Protected Member Functions inherited from Ilwis::Identity
	Identity (const QString &name, qint64 id=i64UNDEF, const QString &cde=sUNDEF, const QString &descr=sUNDEF)

void	prepare (quint64 base=0)

void	setId (quint64 newid)

Protected Attributes
QHash< QString, QVariant >	_properties

QUrl	_resource

QUrlQuery	_urlQuery

std::vector< QUrl >	_container

quint64	_size

QString	_dimensions

IlwisTypes	_ilwtype

IlwisTypes	_extendedType

Detailed Description

Design In Ilwis a Resource is a unique definition of data or processing that can be translated
into a single IlwisObject or Catalog. For example the location to a shape file or a query
on a certain database. A Resource is identified by a unique combination of location
(an url) and type. Often a single data source can be mapped to several resources. E.g
a GeoTiff can be mapped to a GridCoverage obviously but it can also be mapped to a
CoordinateSystem as the data for a full definition of the CoordinateSystem is also part
of the GeoTiff file. Resources can be sub divided into three categories: data objects,
operation objects and catalogs. The data objects can be seen as “Ilwis objects light”
and the catalogs are the containers for these data objects. Containers are defined as
queries on the MasterCatalog).

Resources expose the following properties

URL describing the location of the data source. URL’s may contain fragments
to pinpoint internal resources inside a compound source (the ‘::’ notation of
urls).
The type of the data defined by this resource.
The container location of the resource. For files this is often simply a location
in the hierarchical file system but for services or remote data this may well be
the base url from which the service is called.
Its spatial location/ bounding box. Not relevant for all data types but invaluable
for others.
Creation and modification times.
Supporting objects (by reference). An object can only be understood in its
relation to other objects. A raster without its georeference or domain offers
significant less information
A resource has a unique runtime id that is shared by the Ilwis object or catalog
object it represents.
A name. A string that can be used as reference to the object. Expressions
use the name to select a resource. Names need not be system unique,
though they need to be unique in the context they are used (e.g. A name in a
expression must be unique in the context were the expression is valid, it isn’t
necessarily unique in the context of the MasterCatalog).

An instantiated IlwisObject is always coupled to a Resource. They share the same id

Constructor & Destructor Documentation

Resource::Resource ( )

Constructs an empty Resource

Resource::Resource ( const Resource & resource )

Copy constructor, other resource must not be null

Parameters

resource the Resource that should be copied

Resource::Resource	(	const QUrl &	url,
		quint64	tp,
		bool	isNew = `true`
	)

Creates a resource from an url and a type Will fail if the url or the type is invalid/undefined

Parameters

url	the url that should be used to create this resource
tp	the type of the resource
isNew	set to false if you are not making a new Resource defaults to true (singletons)

Resource::Resource	(	const QString &	name,
		quint64	tp,
		bool	isNew = `true`
	)

Creates a Resource from a description in the form of a namespace name

Parameters

name	name of the resource can be an url or a code
tp	the type of the resource
isNew	set to false if you are not making a new Resource defaults to true (singletons)

Resource::Resource	(	quint64	tp,
		const QUrl &	url = `INTERNAL_OBJECT`
	)

Creates an resource from a file, the file has to be specified with a valid url

Parameters

tp	the type of the resource
url	The url to the file you want to load in this resource

Resource::Resource ( const QSqlRecord & rec )

Creates a new Resource from a Database record, this record should come from the mastercatalog

Parameters

rec

Member Function Documentation

void Resource::addContainer	(	const QUrl &	url,
		int	level = `0`
	)

adds a container to this resource, defines the container this resource is in inside ilwis

Parameters

url	The container that has to be set
level	The level of the new container

void Resource::addProperty	(	const QString &	key,
		const QVariant &	value
	)

Adds a property to this resource, a propert is a combination of a key and a value.
the key can also be seen as the name of the property.

Parameters

key
value

Resource Resource::copy ( quint64 id ) const

Copies this resource, only difference is the id, since Resources are always singletons.

The new Resource will be prepared and than returned

Parameters

id	the id of the copy

Returns: the copy

QString Resource::dimensions ( ) const

Query this Resource for its dimensions.
the dimension of a Resource is in general some form of size, could be in bytes, but stuff like XxY pixels is also possible

Returns

IlwisTypes Resource::extendedType ( ) const

Returns the extended IlwisType

See Also: IlwisObject

Returns: The correct IlwisType

bool Resource::hasProperty ( const QString & property ) const

Checks whether this Resource has a certain property, a resource always has a "name" and a "id"

Parameters

property the property that should be checked

Returns: true if the property excists within this resource

bool Resource::hasUrlQuery ( ) const

Indicates if the Resource has been created with a url containing a query string. If so it can be accessed by urlQuery().

Returns: true if the Resource url has query parameters, false otherwise.

IlwisTypes Resource::ilwisType ( ) const

Returns the ilwis type of this Resource, anything is possible

See Also: IlwisObject

Returns: The correct IlwisType

bool Resource::isValid ( ) const

Checks if this Resource is valid a resource is valid if it has a valid name, a valid IlwisType and the url to the resource is valid

Returns: true if this resource is valid

bool Resource::operator() ( const Ilwis::Resource & resource )

override of the operater, checks whether this Resource is smaller than the supplied resource, returns true if this is the case.
This method is for sorting purposes, it gets sorted first on url, and afterwards on ilwistype

Parameters

resource the resource this should be compared with

Returns: true if this<resource

QVariant Resource::operator[] ( const QString & property ) const

override of the [] operator, allows you to query this resource for some of its data.

You can query either for an "id" or an "name", these will always work, any other property might fail.

Parameters

property the property that should be retrieved from the attributetable

Returns: the Value of the property or iUNDEF

void Resource::prepare ( )

Prepares this Resource

void Resource::setExtendedType ( IlwisTypes tp )

Sets the extendedType of this Resource

See Also: IlwisObject

Parameters

tp	the new extended type of this resource

void Resource::setId ( quint64 newid )

Sets a new id on this Resource. A new id has to be unique, and not registered in the catalog

Parameters

newid the new id of this resource

void Resource::setIlwisType ( IlwisTypes tp )

Sets the ilwistype of this Resource.

usefull in the case the type of this resource can not be resolved from the filename / extension

See Also: IlwisObject

Parameters

tp	the new ilwistype of this resource

void Resource::setName	(	const QString &	nm,
		bool	adaptUrl = `true`
	)

Changes the name of this resource, can adapt the file name on the disk

Parameters

nm	the new name of this Resource
adaptUrl	set to false if you do not want to change the file name

void Resource::setUrl ( const QUrl & url )

Changes The url of this Resource, and thus changes this whole Resource, as it will read the new file and refill all the fields using that.

The url has to be valid though.

Parameters

url	The new url, must be valid

quint64 Resource::size ( ) const

Query for the size of this Resource

Returns: the size of this Resource, cannot be <0

bool Resource::store	(	QSqlQuery &	queryItem,
		QSqlQuery &	queryProperties
	)		const

Store this resource in the sql database

Parameters

queryItem	The item that should be stored
queryProperties	The properties of the item that should be stored

Returns: true if stored succelful

QString Resource::toLocalFile ( bool relative = false ) const

Generates the path to the local file of this Resource (C://etc/etc/etc)

Parameters

relative set to true if you want to generate the path relative to the current working directory

Returns: the path to the local file, returns sUNDEF if something goes wrong

QString Resource::toLocalFile	(	const QUrl &	url,
		bool	relative = `false`,
		const QString &	ext = `sUNDEF`
	)

static

Creates a localfile path representing this Resource.
The url must be valid.

Parameters

url	The location of the file
relative	set to true if you want a path relative to the workingcatalog

Returns: A Qurl to the file if succesful, or else a sUNDEF

QUrl Resource::url ( ) const

Query for the url of this Resource, the url points to the file used to created this Resource

Returns: An url to the file of this Resource

QUrlQuery Resource::urlQuery ( ) const

Gives access to the query when this Resource has been created with a url containing a query string. If there the url did not contain a query string the returned QUrlQuery is empty. This however can be checked via hasUrlQuery() beforehand.

Returns: the query part of the resource url.

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

catalog/resource.h
catalog/resource.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation