blob: fb10e437cc7606690a8a436d7ecc19b987d9626b (
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
/*******************************************************************************
* 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.framework.search.engine;
import java.io.InputStream;
import org.eclipse.osee.framework.core.exception.OseeCoreException;
import org.eclipse.osee.framework.core.exception.OseeStateException;
/**
* @author Roberto E. Escobar
*/
public interface ISearchEngineTagger {
/**
* Create tags for a particular branch.
*
* @param branchId of branch to tag
* @throws OseeStateException
*/
public void tagByBranchId(int branchId) throws OseeCoreException;
/**
* Create tags for a particular branch. Notifies listener of tagging events.
*
* @param listener object listening for tag events
* @param branchId of branch to tag
* @throws OseeStateException
*/
public void tagByBranchId(ITagListener listener, int queryId) throws OseeCoreException;
/**
* Create tags for queue query id.
*
* @param queryId queryId to tag
*/
public void tagByQueueQueryId(int queryId);
/**
* Create tags for queue query id. Notifies listener of tagging events.
*
* @param listener object listening for tag events
* @param queryId queryId to tag
*/
public void tagByQueueQueryId(ITagListener listener, int queryId);
/**
* Create tags for attributes specified in xml stream. <b>
*
* <pre>
* The XML data is formatted as follows:
* <AttributeTag>
* <entry gammaId="90"/>
* <entry gammaId="91"/>
* .
* .
* .
* <AttributeTag>
* </pre>
*
* </b>
*
* @param inputStream xml inputStream
*/
public void tagFromXmlStream(InputStream inputStream) throws Exception;
/**
* Create tags for attributes specified in xml stream. Notifies listener of tagging events. <b>
*
* <pre>
* The XML data is formatted as follows:
* <AttributeTag>
* <entry gammaId="90"/>
* <entry gammaId="91"/>
* .
* .
* .
* <AttributeTag>
* </pre>
*
* </b>
*
* @param listener object listening for tag events
* @param inputStream xml inputStream
*/
public void tagFromXmlStream(ITagListener listener, InputStream inputStream) throws Exception;
/**
* Stop tagging items by queue query id
*
* @param queryId
* @return number of items stopped
*/
public int stopTaggingByQueueQueryId(int... queryId);
/**
* Stops all tagging
*
* @return number of items stopped
*/
public int stopAllTagging();
/**
* Delete tags specified by join query id
*
* @param parseInt
*/
public int deleteTags(int joinQueryId) throws Exception;
/**
* Get number of workers waiting to execute tagging operation
*
* @return number of workers waiting to tag
*/
public int getWorkersInQueue();
/**
* Get statistics
*
* @return tagger statistics
*/
public ITaggerStatistics getStatistics();
/**
* Clear Statistics
*/
public void clearStatistics();
}
|
