Grooper.CMIS.ContainsPredicate

Specifies full-text search criteria in a CMISQL Query. Defines terms and/or phrases which must be present in the full-text content of the document. The syntax of a CONTAINS predicate is as follows:

CONTAINS('<text search expression>')

The text search expression should contain one or more terms or phrases, optionally separated by logical operators (AND/OR/NOT):

A term is a single word entered with no double quotes.
A phrase is a word or group of words surrounded by double quotes.
Terms may contain wildcards. The wildcard ’*’ substitutes for zero or more characters. The wildcard ’?’ substitutes for exactly one character. The characters ’%’ and ’_’, which are wildcards in LIKE expressions, are NOT considered wildcards in a text search expression.
Terms separated by a space or "AND" are AND’ed together.
Terms separated by "OR" are OR’ed together.
AND has higher precedence than OR.
Within a word or phrase, literal ' and " characters must be escaped by a preceding backslash ’\’.
Full text searches are not case-sensitive.

The table below summarizes the major elements of a text search expression:

Element Type	Description	Text Search Expression	CMISQL
Term	A single word without spaces.	computer	CONTAINS('computer')
Phrase	An exact phrase enclosed by double quotes.	"computer software"	CONTAINS('"computer software"')
Wildcard	Words or phrases with the asterisk (*) added to the end.	"compu*"	CONTAINS('"compu*"')
Boolean	Words, phrases, and wildcard strings combined by using the Boolean operators AND, OR, or NOT.	"computer" AND "software program" AND NOT "install component"	CONTAINS('"computer" AND "software program" AND NOT "install component"')

Examples

Below are various examples of text search expressions:

Text Search Expression	Description
grooper AND cmis -or- grooper cmis	Must contain the word "grooper" and the word "cmis".
grooper AND NOT cmis -or- grooper AND -cmis -or- grooper -cmis	Must contain the word "grooper" and not contain the word "cmis".
grooper OR cmis	Must contain either the word "grooper" or the word "cmis".
grooper AND invoice OR customer AND purcase AND order	Must contain either: the words "grooper" and "invoice" or the words "customer", "purchase", and "order".
"grooper cmis"	Must contain the exact phrase "grooper cmis".
payroll report OR expense voucher -or- payroll AND report OR expense AND voucher	Must contain "payroll" and "report" or "expense" and "voucher".

Inherits from: Grooper.CMIS.WherePredicate

Constructors

Signature

Description

New (SearchString As String, Inverted As Boolean)

Parameters

SearchString

Type: String

Inverted

Type: Boolean

Fields

Field Name	Field Type	Description
Criteria As Grooper.CMIS.ContainsPredicate+ContainsPart	Grooper.CMIS.ContainsPredicate.ContainsPart
Inverted As System.Boolean	System.Boolean
SearchString As System.String	System.String

Properties

Property Name	Property Type	Description
IsEmpty	System.Boolean	Returns true if all properties with a ViewableAttribute are set to their default value.
IsWriteable	System.Boolean	Returns true if the object is writable, or false if it is not.

Methods

Method Name

Description

GetInvertedValue(Value As Boolean) As Boolean

Returns the inverse of the passed Boolean value, if this query element's Inverted property is True, otherwise the passed Boolean value is returned.

Parameters

Value

Type: Boolean

GetProperties() As PropertyDescriptorCollection

IsPropertyEnabled(PropertyName As String) As Nullable(Of Boolean)

Defines whether a property is currently enabled.

Parameters

PropertyName

Type: String

The name of the property to determine the enabled state for.

IsPropertyVisible(PropertyName As String) As Nullable(Of Boolean)

Defines whether a property is currently visible.

Parameters

PropertyName

Type: String

The name of the property to determine the visible state for.

IsType(Type As Type) As Boolean

Returns true if the object is of the type specified, or if it derives from the type specfied.

Parameters

Type

Type: Type

The type to check.

ToString() As String

ValidateProperties() As ValidationErrorList

Validates the properties of the object, returning a list of validation errors.