Ilwis-Objects  1.0
GIS and Remote Sensing framework for data access and processing
 All Classes Functions Enumerations Pages
Public Member Functions | List of all members
Ilwis::ConnectorInterface Class Referenceabstract

The ConnectorInterface class all connectors are derived from this interface. More...

#include <connectorinterface.h>

Inheritance diagram for Ilwis::ConnectorInterface:
Ilwis::IlwisObjectConnector Ilwis::CatalogConnector Ilwis::OperationConnector

Public Member Functions

virtual bool loadMetaData (IlwisObject *)
 loads the metadata and non binary information into the ilwisobject. After this method it should be a valid object More...
 
virtual GridloadGridData (IlwisObject *)
 loadGridData loads the 2D or 3D raster data from the source into memory More...
 
virtual bool loadData (IlwisObject *)
 loadData loads bulk binary data into the ilwisobject. More...
 
virtual bool dataIsLoaded () const
 
virtual bool store (IlwisObject *, int)
 
virtual bool execute (const OperationExpression &, ExecutionContext *)
 
virtual bool isReadOnly ()
 isReadOnly returns if a connector can write to a source. More...
 
virtual ConnectorInterfaceclone () const
 clone copies the connector for use with another object More...
 
virtual Resourcesource ()=0
 source returns the resource location were this connector is attached to More...
 
virtual QString provider () const =0
 
virtual void format (const QString &)
 
virtual QString format () const
 
virtual bool isValid () const
 
virtual bool canUse (const Resource &) const
 

Detailed Description

The ConnectorInterface class all connectors are derived from this interface.

*The connector interface enumerates the methods that may be implemented by a derivative. It is unlikely that a derivative will implement all methods so a default implementation is provied. *Usualy the MetaData methods are implemented and depending on the nature of the source also one or more of the binary (Grid/table) ones is implemented.

Member Function Documentation

virtual ConnectorInterface* Ilwis::ConnectorInterface::clone ( ) const
inlinevirtual

clone copies the connector for use with another object

*A connector is dedicated to one IlwisObject only. If one needs an identical connector for whatever reason one can clone it and reuse it

Returns
a new connector
virtual bool Ilwis::ConnectorInterface::isReadOnly ( )
inlinevirtual

isReadOnly returns if a connector can write to a source.

*This return is more of the physical possibility of writing data. There is also a readonly flag at ilwisobject level but describes usualy the logical readonly status (e.g. I dont want that this will be written)

Returns
virtual bool Ilwis::ConnectorInterface::loadData ( IlwisObject )
inlinevirtual

loadData loads bulk binary data into the ilwisobject.

Returns
true when succesfull. If not succesful the reason can be found in the issuelogger

Reimplemented in Ilwis::CatalogConnector.

virtual Grid* Ilwis::ConnectorInterface::loadGridData ( IlwisObject )
inlinevirtual

loadGridData loads the 2D or 3D raster data from the source into memory

*Grid data can be of any size as the memory manager of Ilwis will swap any excess out to its disk cache. *Note that Ilwis doesnt make a difference between 2D and 3D griddata. If the local format has different storage methods for those they have to be resolved at connector level

Returns
returns the allocated grid
virtual bool Ilwis::ConnectorInterface::loadMetaData ( IlwisObject )
inlinevirtual

loads the metadata and non binary information into the ilwisobject. After this method it should be a valid object

Parameters
datathe ilwisobject to be initialized
Returns
bool true when succesfull. If not succesful the reason can be found in the issuelogger

Reimplemented in Ilwis::CatalogConnector.

virtual Resource& Ilwis::ConnectorInterface::source ( )
pure virtual

source returns the resource location were this connector is attached to

Returns
the url of the source

Implemented in Ilwis::IlwisObjectConnector.


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