de.innovationgate.wga.server.api

Class Database

java.lang.Object

de.innovationgate.wga.server.api.Database

Direct Known Subclasses:

App, DataSource

public class Database
extends Object

Object representing any OpenWGA database. Normally only subclasses App or DataSource are created.

Field Summary

Fields

Modifier and Type	Field and Description
static String	QUERYATT_ALLLANGUAGES Name of WebTML query attribute "alllanguages"
static String	QUERYATT_CACHE Name of WebTML query attribute "cache"
static String	QUERYATT_DB Name of WebTML query attribute "db"
static String	QUERYATT_HIGHLIGHT Name of WebTML query attribute "highlight"
static String	QUERYATT_INCLUDECURRENT Name of WebTML query attribute "includecurrent"
static String	QUERYATT_LANGUAGE Name of WebTML query attribute "language"
static String	QUERYATT_MAX Name of WebTML query attribute "max"
static String	QUERYATT_ONLYPUBLISHED Name of WebTML query attribute "onlypublished"
static String	QUERYATT_OPTIONS Name of WebTML query attribute "options"
static String	QUERYATT_ROLE Name of WebTML query attribute "role"
static String	QUERYOUT_SIMPLIFIED_QUERY WebTML output attribute "simplifiedquery", returning a simplified variant of a given Lucene fulltext query

Method Summary

Modifier and Type	Method and Description
static Map<String,Object>	buildDefaultQueryParams(de.innovationgate.webgate.api.WGContent content) Build default query parameters for the given content in context
Context	createTMLContext() Creates a WebTML Context object using this application for context.
de.innovationgate.webgate.api.WGDatabase	db() Returns the corresponding WGAPI WGDatabase object for this app
Domain	domain() Returns a domain object for the domain that this database belongs to
boolean	equals(Object obj)
int	getAccessLevel() Returns the access level that the user has on this database
String	getDbKey() Returns the database key
Object	getPublisherOption(String name) Reads a publisher option configured for the current database This method returns the publisher option value in its native data type, like determined in module registry.
int	hashCode()
boolean	isAnonymous() Returns if the user is logged in anonymously to this database
boolean	isAuthor() Returns if the user has at least AUTHOR access level on this database
boolean	isChiefEditor() Returns if the user has at least CHIEFEDITOR access level on this database
boolean	isEditor() Returns if the user has at least EDITOR access level on this database
boolean	isManager() Returns if the user has MANAGER access level on this database
boolean	isOpen() Returns if the user has access to this database.
boolean	isReader() Returns if the user has at least READER access level on this database
static String	makeQueryParameterName(String str) Creates a valid query parameter name for a given string.
QueryResult	query(String queryType, String queryString) Performs a query on the database This method is the WGA server API pendant to WebTML tag and works quite equal.
QueryResult	query(String queryType, String queryString, Map<String,Object> atts) Performs a query on the database This method is the WGA server API pendant to WebTML tag and works quite equal.
QueryResult	query(String queryType, String queryString, Map<String,Object> atts, Map<String,Object> queryParams) Performs a query on the database This method is the WGA server API pendant to WebTML tag and works quite equal.
QueryResult	query(String queryType, String queryString, Map<String,Object> atts, Map<String,Object> queryParams, Context context) Performs a query on the database This method is the WGA server API pendant to WebTML tag and works quite equal.
void	reopen() Reopens a currently open session on this database with the same authentication If the session is not yet open it will stay closed

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

QUERYOUT_SIMPLIFIED_QUERY

public static final String QUERYOUT_SIMPLIFIED_QUERY

WebTML output attribute "simplifiedquery", returning a simplified variant of a given Lucene fulltext query

See Also:

Constant Field Values

QUERYATT_HIGHLIGHT

public static final String QUERYATT_HIGHLIGHT

Name of WebTML query attribute "highlight"

See Also:

Constant Field Values

QUERYATT_ONLYPUBLISHED

public static final String QUERYATT_ONLYPUBLISHED

Name of WebTML query attribute "onlypublished"

See Also:

Constant Field Values

QUERYATT_OPTIONS

public static final String QUERYATT_OPTIONS

Name of WebTML query attribute "options"

See Also:

Constant Field Values

QUERYATT_MAX

public static final String QUERYATT_MAX

Name of WebTML query attribute "max"

See Also:

Constant Field Values

QUERYATT_ALLLANGUAGES

public static final String QUERYATT_ALLLANGUAGES

Name of WebTML query attribute "alllanguages"

See Also:

Constant Field Values

QUERYATT_ROLE

public static final String QUERYATT_ROLE

Name of WebTML query attribute "role"

See Also:

Constant Field Values

QUERYATT_INCLUDECURRENT

public static final String QUERYATT_INCLUDECURRENT

Name of WebTML query attribute "includecurrent"

See Also:

Constant Field Values

QUERYATT_LANGUAGE

public static final String QUERYATT_LANGUAGE

Name of WebTML query attribute "language"

See Also:

Constant Field Values

QUERYATT_CACHE

public static final String QUERYATT_CACHE

Name of WebTML query attribute "cache"

See Also:

Constant Field Values

QUERYATT_DB

public static final String QUERYATT_DB

Name of WebTML query attribute "db"

See Also:

Constant Field Values

Method Detail

db

public de.innovationgate.webgate.api.WGDatabase db()

Returns the corresponding WGAPI WGDatabase object for this app

query

public QueryResult query(String queryType,
                         String queryString)
                  throws de.innovationgate.webgate.api.WGException

Performs a query on the database This method is the WGA server API pendant to WebTML tag and works quite equal. The mandatory parameters "queryType" and "query" are equal to attribute "type" and the contents of the query tag. The map argument "attributes" uses the names of other -Attributes as keys and interprets them the same way. So filling it with an entry of key "max" and a value 100 will have the same effect as specifying attribute max="100" on a query tag. Specifying or omitting an attribute here has the same effect as it would have on . The map argument "queryParams" takes query parameters that in WebTML you would add to the query by using . Specify parameter names as keys and parameter values as values. The argument "context" determines the WebTML context for which the query runs, which is important for some query types like "lucene" or "hdbmodel:*".

Parameters:

queryType - The type of query to execute

queryString - The actual query to execute

Throws:

de.innovationgate.webgate.api.WGAPIException

WGAServerException

de.innovationgate.webgate.api.WGException

query

public QueryResult query(String queryType,
                         String queryString,
                         Map<String,Object> atts)
                  throws de.innovationgate.webgate.api.WGException

Performs a query on the database This method is the WGA server API pendant to WebTML tag and works quite equal. The mandatory parameters "queryType" and "query" are equal to attribute "type" and the contents of the query tag. The map argument "atts" uses the names of other -Attributes as keys and interprets them the same way. So filling it with an entry of key "max" and a value 100 will have the same effect as specifying attribute max="100" on a query tag. Specifying or omitting an attribute here has the same effect as it would have on . This uses the WebTML context of the environment as query context.

Parameters:

queryType - The type of query to execute

queryString - The actual query to execute

atts - Query attributes. Use attribute names as keys, their values as values

Throws:

de.innovationgate.webgate.api.WGAPIException

WGAServerException

de.innovationgate.webgate.api.WGException

query

public QueryResult query(String queryType,
                         String queryString,
                         Map<String,Object> atts,
                         Map<String,Object> queryParams)
                  throws de.innovationgate.webgate.api.WGException

Performs a query on the database This method is the WGA server API pendant to WebTML tag and works quite equal. The mandatory parameters "queryType" and "query" are equal to attribute "type" and the contents of the query tag. The map argument "atts" uses the names of other -Attributes as keys and interprets them the same way. So filling it with an entry of key "max" and a value 100 will have the same effect as specifying attribute max="100" on a query tag. Specifying or omitting an attribute here has the same effect as it would have on . The map argument "queryParams" takes query parameters that in WebTML you would add to the query by using . Specify parameter names as keys and parameter values as values. This uses the WebTML context of the environment as query context.

Parameters:

queryType - The type of query to execute

queryString - The actual query to execute

atts - Query attributes. Use attribute names as keys, their values as values

queryParams - Query parameters. Use parameter names as keys, values as values

Throws:

de.innovationgate.webgate.api.WGAPIException

WGAServerException

de.innovationgate.webgate.api.WGException

query

public QueryResult query(String queryType,
                         String queryString,
                         Map<String,Object> atts,
                         Map<String,Object> queryParams,
                         Context context)
                  throws de.innovationgate.webgate.api.WGException

Performs a query on the database This method is the WGA server API pendant to WebTML tag and works quite equal. The mandatory parameters "queryType" and "query" are equal to attribute "type" and the contents of the query tag. The map argument "atts" uses the names of other -Attributes as keys and interprets them the same way. So filling it with an entry of key "max" and a value 100 will have the same effect as specifying attribute max="100" on a query tag. Specifying or omitting an attribute here has the same effect as it would have on . The map argument "queryParams" takes query parameters that in WebTML you would add to the query by using . Specify parameter names as keys and parameter values as values. The argument "context" determines the WebTML context for which the query runs, which is important for some query types like "lucene" or "hdbmodel:*".

Parameters:

queryType - The type of query to execute

queryString - The actual query to execute

atts - Query attributes. Use attribute names as keys, their values as values

queryParams - Query parameters. Use parameter names as keys, values as values

context - The WebTML context for the query.

Throws:

de.innovationgate.webgate.api.WGAPIException

WGAServerException

de.innovationgate.webgate.api.WGException

buildDefaultQueryParams

public static Map<String,Object> buildDefaultQueryParams(de.innovationgate.webgate.api.WGContent content)
                                                  throws de.innovationgate.webgate.api.WGException

Build default query parameters for the given content in context

Parameters:

content - The content

Returns:

Map of default query parameters

Throws:

de.innovationgate.webgate.api.WGAPIException

de.innovationgate.webgate.api.WGException

makeQueryParameterName

public static String makeQueryParameterName(String str)
                                     throws de.innovationgate.webgate.api.WGException

Creates a valid query parameter name for a given string. Valid names contain only digits, letters and the underscore. Dashes and spaces are converted to underscores. All other characters omitted.

Parameters:

str - A string to be converted to being a valid query parameter name

Returns:

Valid query parameter name

Throws:

de.innovationgate.webgate.api.WGException

getDbKey

public String getDbKey()

Returns the database key

domain

public Domain domain()
              throws de.innovationgate.webgate.api.WGException

Returns a domain object for the domain that this database belongs to

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

createTMLContext

public Context createTMLContext()
                         throws de.innovationgate.webgate.api.WGException

Creates a WebTML Context object using this application for context. This is a shortcut for WGA.createTMLContext(WGDatabase).

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

getPublisherOption

public Object getPublisherOption(String name)
                          throws de.innovationgate.webgate.api.WGException

Reads a publisher option configured for the current database This method returns the publisher option value in its native data type, like determined in module registry. If the publisher option is not determined for this database this method will return the options default value from the module registry.

Parameters:

name - Name of the publisher option

Returns:

Publisher option value

Throws:

de.innovationgate.webgate.api.WGException

isOpen

public boolean isOpen()

Returns if the user has access to this database. If not many operations on this object will fail.

getAccessLevel

public int getAccessLevel()

Returns the access level that the user has on this database

isAnonymous

public boolean isAnonymous()

Returns if the user is logged in anonymously to this database

isReader

public boolean isReader()

Returns if the user has at least READER access level on this database

isAuthor

public boolean isAuthor()

Returns if the user has at least AUTHOR access level on this database

isEditor

public boolean isEditor()

Returns if the user has at least EDITOR access level on this database

isChiefEditor

public boolean isChiefEditor()

Returns if the user has at least CHIEFEDITOR access level on this database

isManager

public boolean isManager()

Returns if the user has MANAGER access level on this database

reopen

public void reopen()
            throws de.innovationgate.webgate.api.WGException

Reopens a currently open session on this database with the same authentication If the session is not yet open it will stay closed

Throws:

de.innovationgate.webgate.api.WGException