public class Database
extends java.lang.Object
App
or DataSource
are created.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
QUERYATT_ALLLANGUAGES
Name of WebTML query attribute "alllanguages"
|
static java.lang.String |
QUERYATT_CACHE
Name of WebTML query attribute "cache"
|
static java.lang.String |
QUERYATT_DB
Name of WebTML query attribute "db"
|
static java.lang.String |
QUERYATT_HIGHLIGHT
Name of WebTML query attribute "highlight"
|
static java.lang.String |
QUERYATT_INCLUDECURRENT
Name of WebTML query attribute "includecurrent"
|
static java.lang.String |
QUERYATT_LANGUAGE
Name of WebTML query attribute "language"
|
static java.lang.String |
QUERYATT_MAX
Name of WebTML query attribute "max"
|
static java.lang.String |
QUERYATT_ONLYPUBLISHED
Name of WebTML query attribute "onlypublished"
|
static java.lang.String |
QUERYATT_OPTIONS
Name of WebTML query attribute "options"
|
static java.lang.String |
QUERYATT_ROLE
Name of WebTML query attribute "role"
|
static java.lang.String |
QUERYOUT_SIMPLIFIED_QUERY
WebTML output attribute "simplifiedquery", returning a simplified variant of a given Lucene fulltext query
|
Modifier and Type | Method and Description |
---|---|
static java.util.Map<java.lang.String,java.lang.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(java.lang.Object obj) |
int |
getAccessLevel()
Returns the access level that the user has on this database
|
java.lang.String |
getDbKey()
Returns the database key
|
java.lang.Object |
getPublisherOption(java.lang.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.
|
java.lang.String |
getUserName()
Returns the distinguished name of the user currently logged in on this database
|
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
|
boolean |
isUserMemberOf(java.util.List<java.lang.String> names)
Determines if the user currently logged in to the database is contained in the given names list
|
static java.lang.String |
makeQueryParameterName(java.lang.String str)
Creates a valid query parameter name for a given string.
|
QueryResult |
query(java.lang.String queryType,
java.lang.String queryString)
Performs a query on the database
This method is the WGA server API pendant to WebTML tag
|
QueryResult |
query(java.lang.String queryType,
java.lang.String queryString,
java.util.Map<java.lang.String,java.lang.Object> atts)
Performs a query on the database
This method is the WGA server API pendant to WebTML tag
|
QueryResult |
query(java.lang.String queryType,
java.lang.String queryString,
java.util.Map<java.lang.String,java.lang.Object> atts,
java.util.Map<java.lang.String,java.lang.Object> queryParams)
Performs a query on the database
This method is the WGA server API pendant to WebTML tag
|
QueryResult |
query(java.lang.String queryType,
java.lang.String queryString,
java.util.Map<java.lang.String,java.lang.Object> atts,
java.util.Map<java.lang.String,java.lang.Object> queryParams,
Context context)
Performs a query on the database
This method is the WGA server API pendant to WebTML tag
|
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
|
public static final java.lang.String QUERYOUT_SIMPLIFIED_QUERY
public static final java.lang.String QUERYATT_HIGHLIGHT
public static final java.lang.String QUERYATT_ONLYPUBLISHED
public static final java.lang.String QUERYATT_OPTIONS
public static final java.lang.String QUERYATT_MAX
public static final java.lang.String QUERYATT_ALLLANGUAGES
public static final java.lang.String QUERYATT_ROLE
public static final java.lang.String QUERYATT_INCLUDECURRENT
public static final java.lang.String QUERYATT_LANGUAGE
public static final java.lang.String QUERYATT_CACHE
public static final java.lang.String QUERYATT_DB
public de.innovationgate.webgate.api.WGDatabase db()
WGDatabase
object for this apppublic QueryResult query(java.lang.String queryType, java.lang.String queryString) throws de.innovationgate.webgate.api.WGException
queryType
- The type of query to executequeryString
- The actual query to executede.innovationgate.webgate.api.WGAPIException
WGAServerException
de.innovationgate.webgate.api.WGException
public QueryResult query(java.lang.String queryType, java.lang.String queryString, java.util.Map<java.lang.String,java.lang.Object> atts) throws de.innovationgate.webgate.api.WGException
queryType
- The type of query to executequeryString
- The actual query to executeatts
- Query attributes. Use de.innovationgate.webgate.api.WGAPIException
WGAServerException
de.innovationgate.webgate.api.WGException
public QueryResult query(java.lang.String queryType, java.lang.String queryString, java.util.Map<java.lang.String,java.lang.Object> atts, java.util.Map<java.lang.String,java.lang.Object> queryParams) throws de.innovationgate.webgate.api.WGException
queryType
- The type of query to executequeryString
- The actual query to executeatts
- Query attributes. Use queryParams
- Query parameters. Use parameter names as keys, values as valuesde.innovationgate.webgate.api.WGAPIException
WGAServerException
de.innovationgate.webgate.api.WGException
public QueryResult query(java.lang.String queryType, java.lang.String queryString, java.util.Map<java.lang.String,java.lang.Object> atts, java.util.Map<java.lang.String,java.lang.Object> queryParams, Context context) throws de.innovationgate.webgate.api.WGException
queryType
- The type of query to executequeryString
- The actual query to executeatts
- Query attributes. Use queryParams
- Query parameters. Use parameter names as keys, values as valuescontext
- The WebTML context for the query.de.innovationgate.webgate.api.WGAPIException
WGAServerException
de.innovationgate.webgate.api.WGException
public static java.util.Map<java.lang.String,java.lang.Object> buildDefaultQueryParams(de.innovationgate.webgate.api.WGContent content) throws de.innovationgate.webgate.api.WGException
content
- The contentde.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGException
public static java.lang.String makeQueryParameterName(java.lang.String str) throws de.innovationgate.webgate.api.WGException
str
- A string to be converted to being a valid query parameter namede.innovationgate.webgate.api.WGException
public java.lang.String getDbKey()
public Domain domain() throws de.innovationgate.webgate.api.WGException
WGAServerException
de.innovationgate.webgate.api.WGException
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public Context createTMLContext() throws de.innovationgate.webgate.api.WGException
WGA.createTMLContext(WGDatabase)
.WGAServerException
de.innovationgate.webgate.api.WGException
public java.lang.Object getPublisherOption(java.lang.String name) throws de.innovationgate.webgate.api.WGException
name
- Name of the publisher optionde.innovationgate.webgate.api.WGException
public boolean isOpen()
public int getAccessLevel()
public java.lang.String getUserName()
public boolean isAnonymous()
public boolean isReader()
public boolean isAuthor()
public boolean isEditor()
public boolean isChiefEditor()
public boolean isManager()
public void reopen() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public boolean isUserMemberOf(java.util.List<java.lang.String> names) throws de.innovationgate.webgate.api.WGException
names
- A list of user names, group names and role namesde.innovationgate.webgate.api.WGException