com.hcl.domino.dql

Class DQL

java.lang.Object

com.hcl.domino.dql.DQL

public class DQL
extends Object

Utility class to programmatically compose syntactically correct DQL queries and prevent malicous content injection (we hopefully catch all possible threats like using quote characters in search values).

For best code quality, use a static import like this

import static com.hcl.domino.dql.DQL.*;

to import all static methods of this class.
Then you can use methods like item(String), in(String...), inAll(String...) or view(String) directly without the prefix DQL.":

DQLTerm dqlQuery = and(
item("Lastname").isEqualTo("Abbott"),
item("Firstname").isGreaterThan("B")
);

To see the resulting DQL query string, simple call DQL.DQLTerm.toString().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DQL.AllTerm
static class	DQL.AndTerm
static class	DQL.DQLTerm Base class for a variety of DQL search terms
static class	DQL.InViewsOrFoldersTerm
static class	DQL.NamedItem
static class	DQL.NamedView
static class	DQL.NamedViewColumn
static class	DQL.NoteContainsTerm
static class	DQL.NotTerm
static class	DQL.OrTerm
static class	DQL.SpecialValue
static class	DQL.ValueComparisonTerm
static class	DQL.ValueContainsTerm

Constructor Summary

Constructors

Constructor and Description
DQL()

Method Summary

Modifier and Type	Method and Description
static DQL.DQLTerm	all() Returns a DQL term that matches all documents
static DQL.DQLTerm	and(DQL.DQLTerm... terms) Returns a DQL term to do an AND operation on multiple other terms
static DQL.DQLTerm	contains(String... values) Returns a DQL term to run a FT search on the whole note with one or multiple search words.
static DQL.DQLTerm	containsAll(String... values) Returns a DQL term to run a FT search on the whole note with one or multiple search words. All search words must exist in the note for it to be a match.
static DQL.SpecialValue	created() Use this method to filter by @Created value
static DQL.SpecialValue	documentUniqueId() Use this method to filter by @DocumentUniqueId value
static DQL.InViewsOrFoldersTerm	in(String... views) Creates a search term to find documents that exist in at least one of the specified views.
static DQL.InViewsOrFoldersTerm	inAll(String... views) Creates a search term to find documents that exist in multiple views
static DQL.NamedItem	item(String itemName) Use this method to filter for documents with a specific item value
static DQL.SpecialValue	modifiedInThisFile() Use this method to filter by @ModifiedInThisFile value
static DQL.DQLTerm	not(DQL.DQLTerm term) Returns a DQL term to negate the specified term
static DQL.DQLTerm	or(DQL.DQLTerm... terms) Returns a DQL term to do an OR operation on multiple other terms
static DQL.NamedView	view(String viewName) Use this method to filter for documents with a specific view column value

Methods inherited from class java.lang.Object

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

Constructor Detail

DQL

public DQL()

Method Detail

item

public static DQL.NamedItem item(String itemName)

Use this method to filter for documents with a specific item value

Parameters:

itemName - item name

Returns:

object to define the item value and relation (e.g. isEqual to)

view

public static DQL.NamedView view(String viewName)

Use this method to filter for documents with a specific view column value

Parameters:

viewName - view name

Returns:

object to define which column to filter

in

public static DQL.InViewsOrFoldersTerm in(String... views)

Creates a search term to find documents that exist in at least one of the specified views.

Parameters:

views - view names (V10.0 does not support alias names)

Returns:

DQL term

inAll

public static DQL.InViewsOrFoldersTerm inAll(String... views)

Creates a search term to find documents that exist in multiple views

Parameters:

views - view names (V10.0 does not support alias names)

Returns:

DQL term

all

public static DQL.DQLTerm all()

Returns a DQL term that matches all documents

Returns:

term

contains

public static DQL.DQLTerm contains(String... values)

Returns a DQL term to run a FT search on the whole note with one or multiple search words.

Parameters:

values - search words with optional wildcards like Lehm* or Lehman?

Returns:

term

Since:

Domino R11

containsAll

public static DQL.DQLTerm containsAll(String... values)

Returns a DQL term to run a FT search on the whole note with one or multiple search words.
All search words must exist in the note for it to be a match.

Parameters:

values - search words with optional wildcards like Lehm* or Lehman?

Returns:

term

Since:

Domino R11

and

public static DQL.DQLTerm and(DQL.DQLTerm... terms)

Returns a DQL term to do an AND operation on multiple other terms

Parameters:

terms - terms for AND operation

Returns:

AND term

or

public static DQL.DQLTerm or(DQL.DQLTerm... terms)

Returns a DQL term to do an OR operation on multiple other terms

Parameters:

terms - terms for OR operation

Returns:

OR term

not

public static DQL.DQLTerm not(DQL.DQLTerm term)

Returns a DQL term to negate the specified term

Parameters:

term - term to negate

Returns:

negated term

modifiedInThisFile

public static DQL.SpecialValue modifiedInThisFile()

Use this method to filter by @ModifiedInThisFile value

Returns:

object to define a date value and relation (e.g. isGreaterThan / isLess)

documentUniqueId

public static DQL.SpecialValue documentUniqueId()

Use this method to filter by @DocumentUniqueId value

Returns:

object to define the UNID and isEqual relation

created

public static DQL.SpecialValue created()

Use this method to filter by @Created value

Returns:

object to define the creation date to compare with and relation (e.g. isGreaterThan)