public abstract class QueryableSource extends SimpleContentSource
find
init
login
logout
destroy
getTitle
getServerName
getTypeName
Modifier and Type | Class and Description |
---|---|
static class |
QueryableSource.QueryableSourceKey
A temporary key for all results of queryable source
|
COPTION_LANGUAGE, DUMMY_AREA
Constructor and Description |
---|
QueryableSource() |
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
|
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
public int login(java.lang.String user, java.lang.String pwd) throws WGAPIException
SimpleContentSource
login
in class SimpleContentSource
user
- login usernamepwd
- login passwordWGAPIException
public void logout() throws WGAPIException
SimpleContentSource
logout
in class SimpleContentSource
WGAPIException
public java.lang.String getTitle() throws WGBackendException
WGDatabaseCore
getTitle
in interface WGDatabaseCore
getTitle
in class SimpleContentSource
WGBackendException
public java.lang.String getTypeName()
WGDatabaseCore
getTypeName
in interface WGDatabaseCore
getTypeName
in class SimpleContentSource
public java.util.Date getCreated() throws WGBackendException
WGBackendException
public java.lang.Object convertToKey(java.lang.String key, java.lang.String folder) throws WGAPIException
SimpleContentSource
convertToKey
in class SimpleContentSource
key
- The string representatino of the data keyfolder
- The folder of the data keyWGAPIException
public java.lang.Object getContent(java.lang.String folder, java.lang.Object key) throws WGAPIException
SimpleContentSource
getContent
in class SimpleContentSource
folder
- The folder of the objectkey
- The data key of the objectWGAPIException
public boolean insertContent(java.lang.String folder, java.lang.Object key, java.lang.Object bean) throws WGAPIException
SimpleContentSource
insertContent
in class SimpleContentSource
folder
- The folder to insert this data objectkey
- The key for this data object. You may ignore this if this SCS implementation generates it's own keys.bean
- The data object to storeWGAPIException
public boolean updateContent(java.lang.String folder, java.lang.Object key, java.lang.Object bean) throws WGAPIException
SimpleContentSource
updateContent
in class SimpleContentSource
folder
- The folder of the data objectkey
- The data key of the data objectbean
- The data object itself.WGAPIException
public java.lang.Object createContent(java.lang.String folder) throws WGAPIException
SimpleContentSource
createContent
in class SimpleContentSource
folder
- The folder name to create the contentWGAPIException
public java.util.Map find(java.lang.String type, java.lang.String query, java.util.Map parameters) throws WGAPIException
SimpleContentSource
find
in class SimpleContentSource
type
- The query type (which by default should be the folder at which the query is directed)query
- The queryparameters
- Query parameters. Map keys are Constants WGDatabase.QUERYOPTION_...WGAPIException
public abstract java.util.List find(java.lang.String query) throws WGAPIException
query
- The specified query.WGAPIException
public java.util.Date getLastModified() throws WGAPIException
SimpleContentSource
getLastModified
in class SimpleContentSource
WGAPIException
public void removeContent(java.lang.String folder, java.lang.Object key) throws WGAPIException
SimpleContentSource
removeContent
in class SimpleContentSource
folder
- Folder of the data objectkey
- Key of the data objectWGAPIException
public ContentSourceSpecs init(WGDatabase db, java.lang.String path) throws WGAPIException
SimpleContentSource
init
in class SimpleContentSource
db
- The WGAPI database object, that will represent this SCS implementationpath
- The database pathWGAPIException
public void destroy()
SimpleContentSource
destroy
in class SimpleContentSource
public java.lang.String[] getFolders() throws WGAPIException
SimpleContentSource
getFolders
in class SimpleContentSource
WGAPIException
public java.util.Map browse(java.lang.String folder) throws WGAPIException
SimpleContentSource
browse
in class SimpleContentSource
folder
- The folder nameWGAPIException
public java.lang.String getServerName() throws WGAPIException
WGDatabaseCore
WGAPIException