de.innovationgate.webgate.api.templates

Class QueryableSource

java.lang.Object

de.innovationgate.webgate.api.templates.SimpleContentSource

de.innovationgate.webgate.api.templates.QueryableSource

All Implemented Interfaces:

WGDatabaseCore

public abstract class QueryableSource
extends SimpleContentSource

Template that can be used to quickly implement query-only datasources. Mandatory methods to implement:

• find
Optional methods to overwrite:
• init
• login
• logout
• destroy
• getTitle
• getServerName
• getTypeName

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryableSource.QueryableSourceKey A temporary key for all results of queryable source

Field Summary

Fields inherited from class de.innovationgate.webgate.api.templates.SimpleContentSource

COPTION_LANGUAGE, DUMMY_AREA

Constructor Summary

Constructors

Constructor and Description
QueryableSource()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map	browse(java.lang.String folder) Browses the given folder for contents.
java.lang.Object	convertToKey(java.lang.String key, java.lang.String folder) Converts the string representation of a data key to it's real data type.
java.lang.Object	createContent(java.lang.String folder) Creates a new content object in the given folder
void	destroy() Callback method, that gets called when the SCS is closed completely.
abstract java.util.List	find(java.lang.String query) Abstract method to implement query behaviour.
java.util.Map	find(java.lang.String type, java.lang.String query, java.util.Map parameters) Used to implement querying behaviour to the SCS implementation.
java.lang.Object	getContent(java.lang.String folder, java.lang.Object key) Implement to retrieve a single data object by key information.
java.util.Date	getCreated()
java.lang.String[]	getFolders() Implement to return the available folders
java.util.Date	getLastModified() Implement to return a last modified date.
java.lang.String	getServerName() Returns the name of the server for the backend database (if there is one)
java.lang.String	getTitle() Retrieves a descriptive database title.
java.lang.String	getTypeName() Returns a description of this core implementation type.
ContentSourceSpecs	init(WGDatabase db, java.lang.String path) Implement to initialize the SCS implementation when the database gets opened.
boolean	insertContent(java.lang.String folder, java.lang.Object key, java.lang.Object bean) Implement functionality to insert a new data object to a folder
int	login(java.lang.String user, java.lang.String pwd) Implement to specify login behaviour for users opening single sessions.
void	logout() Called when a user session is closed to cleanup resources of it
void	removeContent(java.lang.String folder, java.lang.Object key) Implement behaviour to remove a data object from a folder
boolean	updateContent(java.lang.String folder, java.lang.Object key, java.lang.Object bean) Implement behaviour to update the database backend with new data for a data object

Methods inherited from class de.innovationgate.webgate.api.templates.SimpleContentSource

beginTransaction, beginUpdate, calculateKey, callBackendService, cleanup, clearSessionCache, close, closeSession, commitTransaction, convertFileNameForAttaching, createContent, createCopy, createDesignDocument, createStructEntry, createUserProfile, createWrapper, execProcedure, extractFolder, fastAccess, getACL, getAllContent, getAllContentKeys, getAllowedCredentialClasses, getChildEntries, getContentByKey, getContentByName, getContentCount, getContentStorePatchLevel, getContentStoreVersion, getDedicatedWorkflowEngine, getDeletions, getDesignObject, getDesignObjects, getDummyContent, getExtensionData, getExtensionDataNames, getIncomingRelations, getNativeObject, getParentEntry, getRevision, getRevisionDate, getRoles, getRootEntries, getSpecs, getStructEntryByKey, getStructEntryByName, getUpdatedDocumentsSince, getUpdateLogs, getUserProfile, hasFeature, isBackendServiceSupported, isContentTypeUsed, isLanguageUsed, isMemberOfUserList, moveStructEntry, open, openSession, parseStructKey, query, queryUserProfileNames, refresh, removeExtensionData, resultIsFalse, resultIsTrue, rollbackTransaction, setCurrentSession, writeExtensionData

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryableSource

public QueryableSource()

Method Detail

login

public int login(java.lang.String user,
        java.lang.String pwd)
          throws WGAPIException

Description copied from class: SimpleContentSource

Implement to specify login behaviour for users opening single sessions.

Specified by:

login in class SimpleContentSource

Parameters:

user - login username

pwd - login password

Returns:

A constant WGDatabase.ACCESSLEVEL_... to determine what access the user has on the database, WGDatabase.ACCESSLEVEL_NOTLOGGEDIN if the login should fail

Throws:

WGAPIException

logout

public void logout()
            throws WGAPIException

Description copied from class: SimpleContentSource

Called when a user session is closed to cleanup resources of it

Specified by:

logout in class SimpleContentSource

Throws:

WGAPIException

getTitle

public java.lang.String getTitle()
                          throws WGBackendException

Description copied from interface: WGDatabaseCore

Retrieves a descriptive database title.

Specified by:

getTitle in interface WGDatabaseCore

Specified by:

getTitle in class SimpleContentSource

Returns:

String

Throws:

WGBackendException

getTypeName

public java.lang.String getTypeName()

Description copied from interface: WGDatabaseCore

Returns a description of this core implementation type. Normally in format "dbplatform/dbdesign/furtherInfos/..."

Specified by:

getTypeName in interface WGDatabaseCore

Specified by:

getTypeName in class SimpleContentSource

Returns:

The implementation description

getCreated

public java.util.Date getCreated()
                          throws WGBackendException

Throws:

WGBackendException

convertToKey

public java.lang.Object convertToKey(java.lang.String key,
                            java.lang.String folder)
                              throws WGAPIException

Description copied from class: SimpleContentSource

Converts the string representation of a data key to it's real data type.

Specified by:

convertToKey in class SimpleContentSource

Parameters:

key - The string representatino of the data key

folder - The folder of the data key

Returns:

The converted data key in it's original data type.

Throws:

WGAPIException

getContent

public java.lang.Object getContent(java.lang.String folder,
                          java.lang.Object key)
                            throws WGAPIException

Description copied from class: SimpleContentSource

Implement to retrieve a single data object by key information. This gets called by lazy data fetching, when result maps contain only keys but no data objects.

Specified by:

getContent in class SimpleContentSource

Parameters:

folder - The folder of the object

key - The data key of the object

Returns:

The data object if there is any under this key, null otherwise

Throws:

WGAPIException

insertContent

public boolean insertContent(java.lang.String folder,
                    java.lang.Object key,
                    java.lang.Object bean)
                      throws WGAPIException

Description copied from class: SimpleContentSource

Implement functionality to insert a new data object to a folder

Specified by:

insertContent in class SimpleContentSource

Parameters:

folder - The folder to insert this data object

key - The key for this data object. You may ignore this if this SCS implementation generates it's own keys.

bean - The data object to store

Returns:

true, if insertion succeeded, false otherwise

Throws:

WGAPIException

updateContent

public boolean updateContent(java.lang.String folder,
                    java.lang.Object key,
                    java.lang.Object bean)
                      throws WGAPIException

Description copied from class: SimpleContentSource

Implement behaviour to update the database backend with new data for a data object

Specified by:

updateContent in class SimpleContentSource

Parameters:

folder - The folder of the data object

key - The data key of the data object

bean - The data object itself.

Returns:

true, if update succeeded, false otherwise

Throws:

WGAPIException

createContent

public java.lang.Object createContent(java.lang.String folder)
                               throws WGAPIException

Description copied from class: SimpleContentSource

Creates a new content object in the given folder

Specified by:

createContent in class SimpleContentSource

Parameters:

folder - The folder name to create the content

Returns:

The new content object

Throws:

WGAPIException

find

public java.util.Map find(java.lang.String type,
                 java.lang.String query,
                 java.util.Map parameters)
                   throws WGAPIException

Description copied from class: SimpleContentSource

Used to implement querying behaviour to the SCS implementation.

Specified by:

find in class SimpleContentSource

Parameters:

type - The query type (which by default should be the folder at which the query is directed)

query - The query

parameters - Query parameters. Map keys are Constants WGDatabase.QUERYOPTION_...

Returns:

A map containing the results. Map keys should be data keys. Map values should be data objects or null to use lazy retrieval

Throws:

WGAPIException

find

public abstract java.util.List find(java.lang.String query)
                             throws WGAPIException

Abstract method to implement query behaviour.

Parameters:

query - The specified query.

Returns:

A list of JavaBeans or java.util.Map objects that contain content data

Throws:

WGAPIException

getLastModified

public java.util.Date getLastModified()
                               throws WGAPIException

Description copied from class: SimpleContentSource

Implement to return a last modified date. May return null if this feature is not supported by this SCS implementation.

Specified by:

getLastModified in class SimpleContentSource

Throws:

WGAPIException

removeContent

public void removeContent(java.lang.String folder,
                 java.lang.Object key)
                   throws WGAPIException

Description copied from class: SimpleContentSource

Implement behaviour to remove a data object from a folder

Specified by:

removeContent in class SimpleContentSource

Parameters:

folder - Folder of the data object

key - Key of the data object

Throws:

WGAPIException

init

public ContentSourceSpecs init(WGDatabase db,
                      java.lang.String path)
                        throws WGAPIException

Description copied from class: SimpleContentSource

Implement to initialize the SCS implementation when the database gets opened.

Specified by:

init in class SimpleContentSource

Parameters:

db - The WGAPI database object, that will represent this SCS implementation

path - The database path

Returns:

Specs of this implementation, telling the template what features will get used

Throws:

WGAPIException

destroy

public void destroy()

Description copied from class: SimpleContentSource

Callback method, that gets called when the SCS is closed completely.

Specified by:

destroy in class SimpleContentSource

getFolders

public java.lang.String[] getFolders()
                              throws WGAPIException

Description copied from class: SimpleContentSource

Implement to return the available folders

Specified by:

getFolders in class SimpleContentSource

Returns:

String array of folder names

Throws:

WGAPIException

browse

public java.util.Map browse(java.lang.String folder)
                     throws WGAPIException

Description copied from class: SimpleContentSource

Browses the given folder for contents.

Specified by:

browse in class SimpleContentSource

Parameters:

folder - The folder name

Returns:

A map of data objects. Use data keys as Map keys. Use data objects as Map values or leave values null to use lazy fetching behaviour.

Throws:

WGAPIException

getServerName

public java.lang.String getServerName()
                               throws WGAPIException

Description copied from interface: WGDatabaseCore

Returns the name of the server for the backend database (if there is one)

Throws:

WGAPIException