org.eclipse.stardust.engine.api.query
Class DocumentQuery

java.lang.Object
  extended by org.eclipse.stardust.engine.api.query.Query
      extended by org.eclipse.stardust.engine.api.query.DocumentQuery
All Implemented Interfaces:
Serializable

public class DocumentQuery
extends Query

See Also:
Serialized Form

Nested Class Summary
static class DocumentQuery.MetadataFilterBuilder
           
 
Field Summary
static FilterableAttribute CONTENT
          Allows to define a filter on the document content.
static FilterableAttribute CONTENT_TYPE
          Allows to define a filter on the document's content type.
static FilterableAttribute DATE_CREATED
          Allows to define a filter on the document's creation date.
static FilterableAttribute DATE_LAST_MODIFIED
          Allows to define a filter on the document's last modification date.
static FilterableAttribute DOC_CONTENT
          Alias for CONTENT, suitable for static imports.
static FilterableAttribute DOC_CONTENT_TYPE
          Alias for CONTENT_TYPE, suitable for static imports.
static FilterableAttribute DOC_CREATED
          Alias for DATE_CREATED, suitable for static imports.
static FilterableAttribute DOC_ID
          Alias for ID, suitable for static imports.
static FilterableAttribute DOC_LAST_MODIFIED
          Alias for DATE_LAST_MODIFIED, suitable for static imports.
static DocumentQuery.MetadataFilterBuilder DOC_META_DATA
          Alias for META_DATA, suitable for static imports.
static FilterableAttribute DOC_NAME
          Alias for NAME, suitable for static imports.
static FilterableAttribute DOC_OWNER
          Alias for OWNER, suitable for static imports.
static FilterableAttribute DOCUMENT_TYPE_ID
          Allows to define a filter on the document's documentType id.
static FilterableAttribute DOCUMENT_TYPE_SCHEMA_LOCATION
          Allows to define a filter on the document's documentType schema location.
static FilterableAttribute ID
          Allows to define a filter on the document ID.
static DocumentQuery.MetadataFilterBuilder META_DATA
          Allows to define a filter on the document's metadata attributes.
static FilterableAttribute NAME
          Allows to define a filter on the document name.
static FilterableAttribute OWNER
          Allows to define a filter on the document owner.
static org.eclipse.stardust.engine.api.query.CustomOrderCriterion RELEVANCE
           
 
Constructor Summary
DocumentQuery()
           
 
Method Summary
static DocumentQuery findAll()
          Creates a query for finding all documents currently existing.
 
Methods inherited from class org.eclipse.stardust.engine.api.query.Query
getFilter, getOrderCriteria, getPolicy, orderBy, orderBy, orderBy, removePolicy, setPolicy, toString, where
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final FilterableAttribute ID
Allows to define a filter on the document ID.


NAME

public static final FilterableAttribute NAME
Allows to define a filter on the document name.


CONTENT_TYPE

public static final FilterableAttribute CONTENT_TYPE
Allows to define a filter on the document's content type.


OWNER

public static final FilterableAttribute OWNER
Allows to define a filter on the document owner.


DATE_CREATED

public static final FilterableAttribute DATE_CREATED
Allows to define a filter on the document's creation date.


DATE_LAST_MODIFIED

public static final FilterableAttribute DATE_LAST_MODIFIED
Allows to define a filter on the document's last modification date.


DOCUMENT_TYPE_ID

public static final FilterableAttribute DOCUMENT_TYPE_ID
Allows to define a filter on the document's documentType id.


DOCUMENT_TYPE_SCHEMA_LOCATION

public static final FilterableAttribute DOCUMENT_TYPE_SCHEMA_LOCATION
Allows to define a filter on the document's documentType schema location.


CONTENT

public static final FilterableAttribute CONTENT
Allows to define a filter on the document content.

Please note that only some document types (like plain text, PDF, Microsoft Office documents) support content indexing. Which document types are supported is implied by the concrete DMS.


META_DATA

public static final DocumentQuery.MetadataFilterBuilder META_DATA
Allows to define a filter on the document's metadata attributes.

Supports filters on any attribute (e.g. is there any attribute containing a certain text fragment) or specific attributes (is there an attribute with a given name, containing a certain text fragment).


DOC_ID

public static final FilterableAttribute DOC_ID
Alias for ID, suitable for static imports.


DOC_NAME

public static final FilterableAttribute DOC_NAME
Alias for NAME, suitable for static imports.


DOC_CONTENT_TYPE

public static final FilterableAttribute DOC_CONTENT_TYPE
Alias for CONTENT_TYPE, suitable for static imports.


DOC_OWNER

public static final FilterableAttribute DOC_OWNER
Alias for OWNER, suitable for static imports.


DOC_CREATED

public static final FilterableAttribute DOC_CREATED
Alias for DATE_CREATED, suitable for static imports.


DOC_LAST_MODIFIED

public static final FilterableAttribute DOC_LAST_MODIFIED
Alias for DATE_LAST_MODIFIED, suitable for static imports.


DOC_CONTENT

public static final FilterableAttribute DOC_CONTENT
Alias for CONTENT, suitable for static imports.


DOC_META_DATA

public static final DocumentQuery.MetadataFilterBuilder DOC_META_DATA
Alias for META_DATA, suitable for static imports.


RELEVANCE

public static final org.eclipse.stardust.engine.api.query.CustomOrderCriterion RELEVANCE
Constructor Detail

DocumentQuery

public DocumentQuery()
Method Detail

findAll

public static DocumentQuery findAll()
Creates a query for finding all documents currently existing.

Returns:
The readily configured query.


Copyright © 2017 Eclipse Stardust. All Rights Reserved.