com.versionone.om.filters

Class EntityFilter

java.lang.Object

com.versionone.om.filters.EntityFilter

Direct Known Subclasses:

AttachmentFilter, BaseAssetFilter, EffortFilter, EnvironmentFilter, ExpressionFilter, LinkFilter, MessageReceiptFilter, NoteFilter

public abstract class EntityFilter
extends Object

Base class of all filters.

There is some feature with filtering by createDateUtc or changeDateUtc.

When Entity date and filtering date differs less then one second, the results are undefined. E.g. when filtering by ChangeDateUTC>'2009-02-17 14:45:30.182' an Asset with ChangeDateUTC='2009-02-17T14:45:30.183' | is not returning.

When trying to filter out Assets by ChangeDateUTC GreaterThan some Asset's ChangeDateUTC, result may includes this Asset. (Like in case of using GreaterThanOrEqual). So better not to differ GreaterThan and GreaterThanOrEqual or LessThan and LessThanOrEqual.

The same situation with createDateUtc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityFilter.StringSearcher Specifies a string to search for and an optional set of fields to search in.

Field Summary

Fields

Modifier and Type	Field and Description
DateSearcher	changeDateUtc Filtering conditions that restrict modification date of Entity.
DateSearcher	createDateUtc Filtering conditions that restrict creation date of Entity.
EntityFilter.StringSearcher	find Specify the fields to search in.
List<String>	orderBy Add the names of the properties you wish to sort on.

Constructor Summary

Constructors

Constructor and Description
EntityFilter()

Method Summary

Methods

Modifier and Type	Method and Description
com.versionone.apiclient.IFilterTerm	buildFilter(com.versionone.apiclient.IAssetType assetType, V1Instance instance) Create representation one filter term on a query.
com.versionone.apiclient.QueryFind	buildFind(com.versionone.apiclient.IAssetType assetType) Create QueryFind by assetType and EntityFilter.find.
com.versionone.apiclient.OrderBy	buildOrderBy(com.versionone.apiclient.IAssetType assetType, com.versionone.apiclient.IAttributeDefinition defaultOrderBy) Create OrderBy object with information about ordering.
abstract Class<? extends Entity>	getEntityType() Used by the filtering code to know what types of entities to return when applying the filter.
protected static <T> List<T>	newList()

Methods inherited from class java.lang.Object

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

Field Detail

orderBy

public final List<String> orderBy

Add the names of the properties you wish to sort on. The first in the list is the primary sort, the second is the secondary sort, etc.

find

public final EntityFilter.StringSearcher find

Specify the fields to search in. Add the names of any string (free text) fields on the assets you are searching. If not set, the search will search in Name, Description, and ShortName if there is one.

createDateUtc

public final DateSearcher createDateUtc

Filtering conditions that restrict creation date of Entity.

changeDateUtc

public final DateSearcher changeDateUtc

Filtering conditions that restrict modification date of Entity.

Constructor Detail

EntityFilter

public EntityFilter()

Method Detail

newList

protected static <T> List<T> newList()

getEntityType

public abstract Class<? extends Entity> getEntityType()

Used by the filtering code to know what types of entities to return when applying the filter.

Returns:

class of Entity filter used for.

buildFilter

public com.versionone.apiclient.IFilterTerm buildFilter(com.versionone.apiclient.IAssetType assetType,
                                               V1Instance instance)

Create representation one filter term on a query.

Parameters:

assetType - information about Asset type.

instance - The type this filter belongs to.

Returns:

created IFilterTerm.

buildOrderBy

public com.versionone.apiclient.OrderBy buildOrderBy(com.versionone.apiclient.IAssetType assetType,
                                            com.versionone.apiclient.IAttributeDefinition defaultOrderBy)

Create OrderBy object with information about ordering.

Parameters:

assetType - information about Asset type.

defaultOrderBy - defines methods for the definition of a VersionOne Attribute.

Returns:

created OrderBy.

buildFind

public com.versionone.apiclient.QueryFind buildFind(com.versionone.apiclient.IAssetType assetType)

Create QueryFind by assetType and EntityFilter.find.

Parameters:

assetType - information about Asset type.

Returns:

created object QueryFind.