1 PACKAGE ctx_tree AUTHID current_user AS
2
3 /*------------------------------- TYPE DEFINITIONS ------------------------*/
4
5 /*---------------------------- register_index ----------------------*/
6 /*
7 NAME
8 register_index
9
10 DESCRIPTION
11 registers an index with the CTX_TREE package
12
13 ARGUMENT
14 index_name - the name of the index
15
16 */
17
18 PROCEDURE register_index(
19 index_name IN VARCHAR2
20 );
21 PRAGMA SUPPLEMENTAL_LOG_DATA(register_index, AUTO);
22
23 /*---------------------------- add_node ----------------------*/
24 /*
25 NAME
26 add_node
27
28 DESCRIPTION
29 add a new node to a tree associated with a MVDATA section and index
30
31 ARGUMENT
32 index_name - the name for the index
33 section_name - the name of the MVDATA section
34 path - the new path to be added to a tree
35 id_list - return value of the corresponding node ids
36 force - complete successfully even if the path already
37 exists
38
39 */
40
41 PROCEDURE add_node(
42 index_name IN VARCHAR2,
43 section_name IN VARCHAR2,
44 path IN CLOB,
45 id_list OUT CLOB,
46 force IN BOOLEAN DEFAULT FALSE
47 );
48 PRAGMA SUPPLEMENTAL_LOG_DATA(add_node, AUTO);
49
50 /*---------------------------- get_node_id ----------------------*/
51 /*
52 NAME
53 get_node_id
54
55 DESCRIPTION
56 looks up the node identifier of an existing path in a tree
57 associated with a MVDATA section and index
58
59 ARGUMENT
60 index_name - the name for the index
61 section_name - the name of the MVDATA section
62 path - an existing path in a tree
63 id - return value of the corresponding node id
64
65 */
66
67 PROCEDURE get_node_id(
68 index_name IN VARCHAR2,
69 section_name IN VARCHAR2,
70 path IN CLOB,
71 id OUT INTEGER
72 ) ;
73
74 /*---------------------------- get_children ----------------------*/
75 /*
76 NAME
77 get_children
78
79 DESCRIPTION
80 looks up the children names of the node identified by a path in a tree
81 associated with a MVDATA section and index
82
83 ARGUMENT
84 index_name - the name for the index
85 section_name - the name of the MVDATA section
86 path - an existing path in a tree
87 child_list - return value of the children node names (comma-sep)
88
89 */
90
91 PROCEDURE get_children(
92 index_name IN VARCHAR2,
93 section_name IN VARCHAR2,
94 path IN CLOB,
95 child_list IN OUT CLOB
96 );
97
98 /*---------------------------- get_nodeid_list ----------------------*/
99 /*
100 NAME
101 get_nodeid_list
102
103 DESCRIPTION
104 looks up the node identifiers of all nodes in an existing path in a tree
105 associated with a MVDATA section and index
106
107 ARGUMENT
108 index_name - the name for the index
109 section_name - the name of the MVDATA section
110 path - an existing path in a tree
111 id_list - return value of the corresponding node ids
112
113 */
114
115 PROCEDURE get_nodeid_list(
116 index_name IN VARCHAR2,
117 section_name IN VARCHAR2,
118 path IN CLOB,
119 id_list IN OUT CLOB
120 );
121
122 /*---------------------------- get_roots ----------------------*/
123 /*
124 NAME
125 get_roots
126
127 DESCRIPTION
128 looks up the roots of all the trees associated with a MVDATA section
129 and index
130
131 ARGUMENT
132 index_name - the name for the index
133 section_name - the name of the MVDATA section
134 roots - list of roots (names)
135
136 */
137
138 PROCEDURE get_roots(
139 index_name IN VARCHAR2,
140 section_name IN VARCHAR2,
141 roots OUT CLOB
142 );
143
144 /*---------------------------- remove_node ----------------------*/
145 /*
146 NAME
147 remove_node
148
149 DESCRIPTION
150 Removes specified node from the tree associated with the MVDATA section
151 and Index
152
153 ARGUMENT
154 index_name - the name for the index
155 section_name - the name of the MVDATA section
156 path - input node path to be deleted
157
158 */
159
160 PROCEDURE remove_node(
161 index_name IN VARCHAR2,
162 section_name IN VARCHAR2,
163 path IN CLOB
164 );
165 PRAGMA SUPPLEMENTAL_LOG_DATA(remove_node, AUTO);
166
167 PROCEDURE DropSequences(
168 idx_owner IN VARCHAR2,
169 idx_name IN VARCHAR2,
170 idx_id IN NUMBER
171 );
172
173 PROCEDURE regindex(
174 index_name IN VARCHAR2,
175 purge IN BOOLEAN
176 );
177
178
179
180 END ctx_tree;
[Home] [Help]