blob: 72ce7fe362857ae5e85093a19eafc646931e442d (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
/*******************************************************************************
* Copyright (c) 2004, 2007 Boeing.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Boeing - initial API and implementation
*******************************************************************************/
package org.eclipse.osee.orcs.search;
import java.util.Collection;
import org.eclipse.osee.framework.core.data.IAttributeType;
import org.eclipse.osee.framework.core.data.IRelationTypeSide;
import org.eclipse.osee.framework.core.data.TokenFactory;
import org.eclipse.osee.framework.core.enums.LoadLevel;
import org.eclipse.osee.framework.core.exception.OseeCoreException;
import org.eclipse.osee.orcs.data.ReadableArtifact;
public interface QueryBuilder {
public static IAttributeType ANY_ATTRIBUTE_TYPE = TokenFactory.createAttributeType(Long.MIN_VALUE,
"Any Attribute Type");
QueryBuilder includeCache();
QueryBuilder includeCache(boolean enabled);
boolean isCacheIncluded();
QueryBuilder includeDeleted();
QueryBuilder includeDeleted(boolean enabled);
boolean areDeletedIncluded();
QueryBuilder includeTypeInheritance();
QueryBuilder includeTypeInheritance(boolean enabled);
boolean isTypeInheritanceIncluded();
QueryBuilder fromTransaction(int transactionId);
int getFromTransaction();
QueryBuilder headTransaction();
boolean isHeadTransaction();
QueryBuilder excludeCache();
QueryBuilder excludeDeleted();
QueryBuilder excludeTypeInheritance();
/**
* Resets query builder to default settings. This also clear all criteria added to original query.
*/
QueryBuilder resetToDefaults();
/**
* Search criteria that checks for the existence of an attribute type.
*/
QueryBuilder andExists(IAttributeType attributeType) throws OseeCoreException;
/**
* Search criteria that follows the relation link ending on the given side
*
* @param relationType the type-side to start following the link from
*/
QueryBuilder andExists(IRelationTypeSide relationType) throws OseeCoreException;
/**
* Search criteria that finds an attribute of the given type with its current value relative to the given value based
* on the operator provided.
*/
QueryBuilder and(IAttributeType attributeType, Operator operator, String value) throws OseeCoreException;
/**
* Search criteria that finds an attribute of the given type with its current value exactly equal (or not equal) to
* any one of the given literal values. If the list only contains one value, then the search is conducted exactly as
* if the single value constructor was called. This search does not support the (* wildcard) for multiple values.
*/
QueryBuilder and(IAttributeType attributeType, Operator operator, Collection<String> values) throws OseeCoreException;
/**
* Creates a result set based on query settings
*
* @see LoadLevel level
*/
ResultSet<ReadableArtifact> build(LoadLevel loadLevel) throws OseeCoreException;
/**
* Counts the number of items available
*/
int getCount() throws OseeCoreException;
}
|
