Revision 878
Added by berkley about 23 years ago
docs/user/metacatout.html | ||
---|---|---|
1 |
<!-- |
|
2 |
* Metacatout.html |
|
3 |
* |
|
4 |
* Authors: Jivka Bojilova |
|
5 |
* Copyright: 2000 Regents of the University of California and the |
|
6 |
* National Center for Ecological Analysis and Synthesis |
|
7 |
* For Details: http://www.nceas.ucsb.edu/ |
|
8 |
* Created: 2000 April 5 |
|
9 |
* Version: 0.01 |
|
10 |
* File Info: '$Id$' |
|
11 |
* |
|
12 |
* October Meeting SDSC, 2000 |
|
13 |
--> |
|
14 |
<HTML> |
|
15 |
<HEAD> |
|
16 |
<TITLE>Metacat</TITLE> |
|
17 |
<link rel="stylesheet" type="text/css" href="@docrooturl@default.css"> |
|
18 |
</HEAD> |
|
19 |
<BODY> |
|
20 |
<table width="100%"> |
|
21 |
<tr> |
|
22 |
<td class="tablehead" colspan="2"><p class="label">Output Transformations</p></td> |
|
23 |
<td class="tablehead" colspan="2" align="right"> |
|
24 |
<a href="./acontrol.html">Back</a> | <a href="./metacattour.html">Home</a> | |
|
25 |
<a href="./metacatapi.html">Next</a> |
|
26 |
</td> |
|
27 |
</tr> |
|
28 |
</table> |
|
29 |
<p>Metacat uses XML for data exchange between the client application and |
|
30 |
the server.</p> |
|
31 |
|
|
32 |
<p>XSLT is used for transformations for visual presentation (e.g. XML->HTML). |
|
33 |
It can also be used to tranlate between different types of heterogeneous XML documents |
|
34 |
which are symantically similar.</p> |
|
35 |
|
|
36 |
<img src="xmltransform.gif"> |
|
37 |
|
|
38 |
<p>Metacat can be set on the fly to either transform or not transform a resultset |
|
39 |
from XML. This is achieved by setting the 'qformat' servlet parameter to 'html' |
|
40 |
or 'xml'. When qformat is set to html, Metacat will transform the resultset based |
|
41 |
on the stylesheet specified in the resultStyleURL of the |
|
42 |
<a href="./properties.html">Metacat Properties</a> file. This XSL stylesheet |
|
43 |
defines the rules for how to translate the XML tags into HTML tags. |
|
44 |
</p> |
|
45 |
<p>A user can specify that a certain doctype is always transformed using a |
|
46 |
specific stylesheet by registering that stylesheet in the Metacat Catalog. |
|
47 |
The Catalog is stored in the database table xml_catalog and contains a |
|
48 |
list of doctypes and the stylesheets used to transform them. If a doctype |
|
49 |
has an assigned stylesheet, whenever a document of that type is "read" from |
|
50 |
Metacat and qformat is set to HTML, the document will be transformed using |
|
51 |
the assigned stylesheet. |
|
52 |
</p> |
|
53 |
|
|
54 |
<br> |
|
55 |
<a href="./acontrol.html">Back</a> | <a href="./metacattour.html">Home</a> | |
|
56 |
<a href="./metacatapi.html">Next</a> |
|
57 |
|
|
58 |
</BODY> |
|
59 |
</HTML> |
|
60 |
|
|
0 | 61 |
docs/user/packages.html | ||
---|---|---|
1 |
<!-- |
|
2 |
* packages.html |
|
3 |
* |
|
4 |
* Authors: Chad Berkley |
|
5 |
* Copyright: 2000 Regents of the University of California and the |
|
6 |
* National Center for Ecological Analysis and Synthesis |
|
7 |
* For Details: http://www.nceas.ucsb.edu/ |
|
8 |
* Created: 2001 January 23 |
|
9 |
* Version: |
|
10 |
* File Info: '$ ' |
|
11 |
* |
|
12 |
* |
|
13 |
--> |
|
14 |
<HTML> |
|
15 |
<HEAD> |
|
16 |
<TITLE>Metacat</TITLE> |
|
17 |
<link rel="stylesheet" type="text/css" href="@docrooturl@default.css"> |
|
18 |
</HEAD> |
|
19 |
<BODY> |
|
20 |
<table width="100%"> |
|
21 |
<tr> |
|
22 |
<td class="tablehead" colspan="2"><p class="label">Packages and Relationships</p></td> |
|
23 |
<td class="tablehead" colspan="2" align="right"> |
|
24 |
<a href="./metacatapi.html">Back</a> | <a href="./metacattour.html">Home</a> | |
|
25 |
<a href="./replication.html">Next</a> |
|
26 |
</td> |
|
27 |
</tr> |
|
28 |
</table> |
|
29 |
<p>Metacat allows a user to create a virtual link between XML documents within |
|
30 |
the system. These links are called <i>Relationships</i> and are defined by triples |
|
31 |
in <i>eml-dataset-2.0</i> files. A relationship can be defined between two |
|
32 |
XML or <a href="./datafiles.html">non-XML</a> files. |
|
33 |
The following is an example of an eml-dataset-2.0 file holding triples at the end:</p> |
|
34 |
|
|
35 |
<pre> |
|
36 |
<?xml version="1.0"?> |
|
37 |
<!DOCTYPE dataset PUBLIC "-//NCEAS//eml-dataset-2.0//EN" "eml-dataset-2.0.dtd"> |
|
38 |
<dataset> |
|
39 |
<identifier system="null">berkley.5.3</identifier> |
|
40 |
<shortName>allsp</shortName> |
|
41 |
<title>MARINE sampling data collected between spring 1992 and fall 1996</title> |
|
42 |
<originator> |
|
43 |
<individualName> |
|
44 |
<salutation>Dr.</salutation> |
|
45 |
<givenName>Peter</givenName> |
|
46 |
<surName>Raimondi</surName> |
|
47 |
</individualName> |
|
48 |
<organizationName>UCSC</organizationName> |
|
49 |
<positionName> </positionName> |
|
50 |
<address> |
|
51 |
<deliveryPoint>Biology Dept.</deliveryPoint> |
|
52 |
<deliveryPoint>A309 Earth and Marine Science Building</deliveryPoint> |
|
53 |
<city>Santa Cruz</city> |
|
54 |
<administrativeArea>CA</administrativeArea> |
|
55 |
<postalCode>95060</postalCode> |
|
56 |
<country>USA</country> |
|
57 |
</address> |
|
58 |
<phone phonetype="voice">831-459-1234 x5674</phone> |
|
59 |
<electronicMailAddress>raimondi@biology.ucsc.edu</electronicMailAddress> |
|
60 |
<onlineLink> </onlineLink> |
|
61 |
<role>Originator</role> |
|
62 |
</originator> |
|
63 |
<pubdate> </pubdate> |
|
64 |
<pubplace> </pubplace> |
|
65 |
<series> </series> |
|
66 |
<abstract> |
|
67 |
<paragraph> </paragraph> |
|
68 |
</abstract> |
|
69 |
<keywordSet> |
|
70 |
<keyword keywordType="null">intertidal</keyword> |
|
71 |
<keyword keywordType="null">santa barbara</keyword> |
|
72 |
<keyword keywordType="null">photoplot</keyword> |
|
73 |
<keyword keywordType="null">quadrat</keyword> |
|
74 |
<keywordThesaurus> </keywordThesaurus> |
|
75 |
</keywordSet> |
|
76 |
<additionalInfo> |
|
77 |
<paragraph> </paragraph> |
|
78 |
</additionalInfo> <font color="red"> |
|
79 |
<triple> |
|
80 |
<subject>berkley.6.1</subject> |
|
81 |
<relationship>isRelatedTo</relationship> |
|
82 |
<object>berkley.5.3</object> |
|
83 |
</triple> |
|
84 |
<triple> |
|
85 |
<subject>berkley.7.1</subject> |
|
86 |
<relationship>isRelatedTo</relationship> |
|
87 |
<object>berkley.6.1</object> |
|
88 |
</triple> |
|
89 |
<triple> |
|
90 |
<subject>berkley.8.1</subject> |
|
91 |
<relationship>isRelatedTo</relationship> |
|
92 |
<object>berkley.5.3</object> |
|
93 |
</triple> |
|
94 |
<triple> |
|
95 |
<subject>berkley.8.1</subject> |
|
96 |
<relationship>isRelatedTo</relationship> |
|
97 |
<object>berkley.6.1</object> |
|
98 |
</triple> |
|
99 |
<triple> |
|
100 |
<subject>berkley.8.1</subject> |
|
101 |
<relationship>isRelatedTo</relationship> |
|
102 |
<object>berkley.7.1</object> |
|
103 |
</triple> |
|
104 |
<triple> |
|
105 |
<subject>berkley.14.1</subject> |
|
106 |
<relationship>isRelatedTo</relationship> |
|
107 |
<object>berkley.6.1</object> |
|
108 |
</triple> </font> |
|
109 |
<temporalCoverage> 1992 to 1996</temporalCoverage> |
|
110 |
<geographicCoverage> </geographicCoverage> |
|
111 |
<taxonomicCoverage> </taxonomicCoverage> |
|
112 |
</dataset> |
|
113 |
</pre> |
|
114 |
|
|
115 |
<b>Description of the Package File</b> |
|
116 |
<p>Note that the doctype of this document is an unregistered NCEAS specific |
|
117 |
DTD (-//NCEAS//eml-dataset-2.0//EN). The package doctype is an application |
|
118 |
property of Metacat. Setting this property (and others) is described in |
|
119 |
<a href="./properties.html">Setting Metacat Properties</a>. The package file |
|
120 |
is broken up into <i>n</i> triples. Each triple has a subject, relationship, |
|
121 |
and an object. This grouping can be read as follows: <subject> has |
|
122 |
<relationship> to <object>. Each triple is a logical link |
|
123 |
between the subject and object with the relationship being a description of that |
|
124 |
link.</p> |
|
125 |
<b>The Utility of Relations</b> |
|
126 |
<p>Relations become useful because many XML data schemas are broken up into |
|
127 |
multiple DTDs. Thus, there may be many different XML files that are all |
|
128 |
related to each other yet are stored seperately within the system. Also, |
|
129 |
since we, here at NCEAS, are developing Metacat for use as a metadata |
|
130 |
repository for ecological data, we need some way of linking our metadata |
|
131 |
to the datafiles that they describe. Packages are the way we do this.</p> |
|
132 |
<b>Post Processed Relations</b> |
|
133 |
<p>The package file is inserted into Metacat as any other file is. Its doctype |
|
134 |
is checked against the packagedoctype property in the <a href="properties.html"> |
|
135 |
Metacat.properties file</a>. If it is of that type, the file is sent |
|
136 |
to a postprocessor to be analyzed and inserted into the xml_relation table. |
|
137 |
The table looks like the following:</p> |
|
138 |
|
|
139 |
<table border="1"> |
|
140 |
<tr> |
|
141 |
<td>relationid</td><td>docid</td><td>packagetype</td> |
|
142 |
<td>subject</td><td>subjectdoctype</td> |
|
143 |
<td>relationship</td><td>object</td><td>objectdoctype</td> |
|
144 |
</tr> |
|
145 |
<tr> |
|
146 |
<td>1</td> |
|
147 |
<td>berkley.5</td> |
|
148 |
<td>-//NCEAS//eml-dataset-2.0//EN</td> |
|
149 |
<td>berkley.6.1</td> |
|
150 |
<td>null</td> |
|
151 |
<td>isRelatedTo</td> |
|
152 |
<td>berkley.5.3</td> |
|
153 |
<td>null</td> |
|
154 |
</tr> |
|
155 |
<tr> |
|
156 |
<td>2</td> |
|
157 |
<td>berkley.5</td> |
|
158 |
<td>-//NCEAS//eml-dataset-2.0//EN</td> |
|
159 |
<td>berkley.7.1</td> |
|
160 |
<td>null</td> |
|
161 |
<td>isRelatedTo</td> |
|
162 |
<td>berkley.6.1</td> |
|
163 |
<td>null</td> |
|
164 |
</tr> |
|
165 |
<tr> |
|
166 |
<td>3</td> |
|
167 |
<td>berkley.5</td> |
|
168 |
<td>-//NCEAS//eml-dataset-2.0//EN</td> |
|
169 |
<td>berkley.8.1</td> |
|
170 |
<td>null</td> |
|
171 |
<td>isRelatedTo</td> |
|
172 |
<td>berkley.5.3</td> |
|
173 |
<td>null</td> |
|
174 |
</tr> |
|
175 |
<tr> |
|
176 |
<td>4</td> |
|
177 |
<td>berkley.5</td> |
|
178 |
<td>-//NCEAS//eml-dataset-2.0//EN</td> |
|
179 |
<td>berkley.8.1</td> |
|
180 |
<td>null</td> |
|
181 |
<td>isRelatedTo</td> |
|
182 |
<td>berkley.6.1</td> |
|
183 |
<td>null</td> |
|
184 |
</tr> |
|
185 |
<tr> |
|
186 |
<td>5</td> |
|
187 |
<td>berkley.5</td> |
|
188 |
<td>-//NCEAS//eml-dataset-2.0//EN</td> |
|
189 |
<td>berkley.8.1</td> |
|
190 |
<td>null</td> |
|
191 |
<td>isRelatedTo</td> |
|
192 |
<td>berkley.7.1</td> |
|
193 |
<td>null</td> |
|
194 |
</tr> |
|
195 |
<tr> |
|
196 |
<td>6</td> |
|
197 |
<td>berkley.5</td> |
|
198 |
<td>-//NCEAS//eml-dataset-2.0//EN</td> |
|
199 |
<td>berkley.14.1</td> |
|
200 |
<td>null</td> |
|
201 |
<td>isRelatedTo</td> |
|
202 |
<td>berkley.6.1</td> |
|
203 |
<td>null</td> |
|
204 |
</tr> |
|
205 |
</table> |
|
206 |
|
|
207 |
<p>Once, the system has processed the package file and inserted the relations |
|
208 |
into the xml_relation table, the files relations are always returned to with it |
|
209 |
in the <a href="./metacatquery.html">resultset</a> of a query.</p> |
|
210 |
|
|
211 |
<b>Package Views (formerly known as 'backtracking')</b> |
|
212 |
<p>Package View is a feature that was intentionally left out of the |
|
213 |
<a href="./Metacatquery.html">Queries and Results</a> section. Package views |
|
214 |
involves sending a doctype (called a returndoctype) along with a query request. |
|
215 |
When there is a hit from that query, the system will check the doctype of the |
|
216 |
hit document against the returndoctype. If the doctypes do not match, |
|
217 |
the system checks the xml_relation table to see if that document has been packed |
|
218 |
by document of that doctype. If such package document exists, it |
|
219 |
is returned instead of the one which was originally hit. If no such |
|
220 |
package document exists, then the document which was originally hit is returned. |
|
221 |
This allows a display system (such as a web browser) to try to display a |
|
222 |
certain type of document.</p> |
|
223 |
<p>For example: Take our package file from above. Say we do a query for |
|
224 |
"intertidal" which returns the document berkley.6 of type -//NCEAS//eml-entity-2.0//EN. |
|
225 |
However, we have set returndoctype equal to "-//NCEAS//eml-dataset-2.0//EN". |
|
226 |
When berkley.6 is hit, the system will check its package documents to see if |
|
227 |
it is of type -//NCEAS//eml-dataset-2.0//EN. Since it is, |
|
228 |
(relationid 1, 2 and 4) document berkley.5 is returned instead of berkley.6. |
|
229 |
<p>From a client the returndoctype is a servlet parameter. |
|
230 |
A URL with a returndoctype would look something like: </p> |
|
231 |
<pre>http://server.domain.com/Metacat?action=query&anyfield=%&qformat=html&returndoctype=-//NCEAS//eml-dataset-2.0//EN</pre> |
|
232 |
<p>The system then inserts the returndoctype parameter value into a pathquery |
|
233 |
document as illustrated in <a href="./metacatquery.html">Queries and Results</a>. |
|
234 |
</p> |
|
235 |
|
|
236 |
|
|
237 |
<br> |
|
238 |
<a href="./metacatapi.html">Back</a> | <a href="./metacattour.html">Home</a> | |
|
239 |
<a href="./replication.html">Next</a> |
|
240 |
|
|
241 |
|
|
242 |
</BODY> |
|
243 |
</HTML> |
|
0 | 244 |
docs/user/saxparser.html | ||
---|---|---|
1 |
<!-- |
|
2 |
* saxparser.html |
|
3 |
* |
|
4 |
* Authors: Jivka Bojilova |
|
5 |
* Copyright: 2000 Regents of the University of California and the |
|
6 |
* National Center for Ecological Analysis and Synthesis |
|
7 |
* For Details: http://www.nceas.ucsb.edu/ |
|
8 |
* Created: 2000 April 5 |
|
9 |
* Version: 0.01 |
|
10 |
* File Info: '$Id$' |
|
11 |
* |
|
12 |
* October Meeting SDSC, 2000 |
|
13 |
--> |
|
14 |
<HTML> |
|
15 |
<HEAD> |
|
16 |
<TITLE>Metacat</TITLE> |
|
17 |
<link rel="stylesheet" type="text/css" href="@docrooturl@default.css"> |
|
18 |
</HEAD> |
|
19 |
<BODY> |
|
20 |
<table width="100%"> |
|
21 |
<tr> |
|
22 |
<td class="tablehead" colspan="2"><p class="label">XML Parsing with SAX</p></td> |
|
23 |
<td class="tablehead" colspan="2" align="right"> |
|
24 |
<a href="./metacatread.html">Back</a> | <a href="./metacattour.html">Home</a> | |
|
25 |
<a href="./xmlindex.html">Next</a> |
|
26 |
</td> |
|
27 |
</tr> |
|
28 |
</table> |
|
29 |
<P>SAX, the <i>Simple API for XML</i>, is |
|
30 |
a standard interface for event-based XML parsing. The SAX API provides implemented |
|
31 |
interfaces for many different XML parsers. Metacat requires a SAX2 |
|
32 |
API/Java1.2 with any SAX2-compatible XML parser. |
|
33 |
<P>To avoid tying Metacat to any specific SAX parser, XMLReaderFactory is used |
|
34 |
as the SAX interface to Metacat for easy plugability of parsers. The SAX parser |
|
35 |
used must be set in the <a href="./properties.html">Metacat Properties</a> file.</p> |
|
36 |
<p>The following is an example of instatiating a parser for Metacat.</p> |
|
37 |
<PRE> |
|
38 |
XMLReader parser = null; |
|
39 |
// Set up the SAX document handlers for parsing |
|
40 |
try { |
|
41 |
ContentHandler chandler = new DBSAXHandler(conn, action, docid, user); |
|
42 |
EntityResolver dbresolver = new DBEntityResolver(conn, (DBSAXHandler)chandler); |
|
43 |
DTDHandler dtdhandler = new DBDTDHandler(conn); |
|
44 |
|
|
45 |
// Get an instance of the parser |
|
46 |
MetacatUtil util = new MetacatUtil(); |
|
47 |
// Get the class name of SAX driver from some XML parser like: |
|
48 |
// org.apache.xerces.parsers.SAXParser |
|
49 |
<span class="emphasis">String parserName = util.getOption("saxparser");</span> |
|
50 |
// Given a class name, this method attempts to load and instantiate the class as an XML reader |
|
51 |
<span class="emphasis">parser = XMLReaderFactory.createXMLReader(parserName);</span> |
|
52 |
|
|
53 |
// Turn off validation |
|
54 |
parser.setFeature("http://xml.org/sax/features/validation", false); |
|
55 |
|
|
56 |
parser.setProperty("http://xml.org/sax/properties/declaration-handler", chandler); |
|
57 |
parser.setProperty("http://xml.org/sax/properties/lexical-handler", chandler); |
|
58 |
|
|
59 |
// Set Handlers in the parser to receive XML parsing events |
|
60 |
parser.setContentHandler((ContentHandler)chandler); |
|
61 |
parser.setEntityResolver((EntityResolver)dbresolver); |
|
62 |
parser.setDTDHandler((DTDHandler)dtdhandler); |
|
63 |
parser.setErrorHandler((ErrorHandler)chandler); |
|
64 |
|
|
65 |
} catch (SAXException saxe) { |
|
66 |
throw saxe; |
|
67 |
} |
|
68 |
|
|
69 |
</PRE> |
|
70 |
|
|
71 |
<br> |
|
72 |
<a href="./metacatread.html">Back</a> | <a href="./metacattour.html">Home</a> | |
|
73 |
<a href="./xmlindex.html">Next</a> |
|
74 |
|
|
75 |
</BODY> |
|
76 |
</HTML> |
|
77 |
|
|
0 | 78 |
docs/user/replication.html | ||
---|---|---|
1 |
<!-- |
|
2 |
* replication.html |
|
3 |
* |
|
4 |
* Authors: Chad Berkley |
|
5 |
* Copyright: 2000 Regents of the University of California and the |
|
6 |
* National Center for Ecological Analysis and Synthesis |
|
7 |
* For Details: http://www.nceas.ucsb.edu/ |
|
8 |
* Created: 2001 January 23 |
|
9 |
* Version: |
|
10 |
* File Info: '$ ' |
|
11 |
* |
|
12 |
* |
|
13 |
--> |
|
14 |
<HTML> |
|
15 |
<HEAD> |
|
16 |
<TITLE>Metacat</TITLE> |
|
17 |
<link rel="stylesheet" type="text/css" href="@docrooturl@default.css"> |
|
18 |
</HEAD> |
|
19 |
<BODY> |
|
20 |
<table width="100%"> |
|
21 |
<tr> |
|
22 |
<td class="tablehead" colspan="2"><p class="label">Replication</p></td> |
|
23 |
<td class="tablehead" colspan="2" align="right"> |
|
24 |
<a href="./packages.html">Back</a> | <a href="./metacattour.html">Home</a> | |
|
25 |
<a href="./datafiles.html">Next</a> |
|
26 |
</td> |
|
27 |
</tr> |
|
28 |
</table> |
|
29 |
<p>Metacat has built in replication to allow different Metacat servers to |
|
30 |
share data between themselves. The replication scheme that Metacat uses is |
|
31 |
both push and pull. There are several triggers that can start a replication |
|
32 |
mechanism. </p> |
|
33 |
<ul> |
|
34 |
<li>Delta-T monitoring. At a set time interval a server checks each of the |
|
35 |
other servers in its list for updated documents</li> |
|
36 |
<li>INSERT trigger. Whenever a document is inserted, the server notifies |
|
37 |
the remote hosts in its list that it has a new file available.</li> |
|
38 |
<li>UPDATE trigger. Whenever a document is updated, the server notifies |
|
39 |
each server in its list of the update.</li> |
|
40 |
<li>File locking. When a local user tries to alter a document on a local |
|
41 |
server that belongs to a remote server, the local server must first |
|
42 |
obtain a lock on that file. Once the lock is obtained, the file can |
|
43 |
be updated, then it is force replicated out to each server in the list. |
|
44 |
The lock ensures that the remote copy is up to date and that an older |
|
45 |
file does not overwrite a newer one. Only a documents home server |
|
46 |
can give a lock for that file to be altered.</li> |
|
47 |
</ul> |
|
48 |
<p>Each server contains a list of servers to which it can replicate. One-way |
|
49 |
replication is enabled by the 'replicate' flag in the list. The server list |
|
50 |
may look like the following.</p> |
|
51 |
<table border="1"> |
|
52 |
<tr> |
|
53 |
<td><b>serverid</b></td> |
|
54 |
<td><b>server</b></td> |
|
55 |
<td><b>last_checked</b></td> |
|
56 |
<td><b>replicate</b></td> |
|
57 |
</tr> |
|
58 |
<tr> |
|
59 |
<td>1</td> |
|
60 |
<td>localhost</td> |
|
61 |
<td>null</td> |
|
62 |
<td>0</td> |
|
63 |
</tr> |
|
64 |
<tr> |
|
65 |
<td>2</td> |
|
66 |
<td>alpha.nceas.ucsb.edu:8080/berkley/servlet/replication</td> |
|
67 |
<td>2001-01-22 14:52:12.1</td> |
|
68 |
<td>1</td> |
|
69 |
</tr> |
|
70 |
<tr> |
|
71 |
<td>3</td> |
|
72 |
<td>dev.nceas.ucsb.edu/Metacat/servlet/replication</td> |
|
73 |
<td>2001-01-23 9:10:02.5</td> |
|
74 |
<td>1</td> |
|
75 |
</tr> |
|
76 |
</table> |
|
77 |
|
|
78 |
<p>The server list is kept in a table in the database called xml_replication. |
|
79 |
Localhost must always be the first entry in the table and have a serverid of 1. |
|
80 |
The server field must always point to the other server's replication servlet, |
|
81 |
hence the servlet/replication on the end of both of the sample servers. Note |
|
82 |
that any port numbers (if your servlet engine is not running on port 80) must |
|
83 |
also be included. The replicate flag is set to 1 if you want this server to |
|
84 |
copy data TO the remote host. (Note that both servers (the local host and |
|
85 |
the remote host) must have each other in their respective tables or replication |
|
86 |
will not take place.)</p> |
|
87 |
<b>Example:</b> |
|
88 |
<table border="1"> |
|
89 |
<tr> |
|
90 |
<td>host</td> |
|
91 |
<td>replication table</td> |
|
92 |
</tr> |
|
93 |
<tr> |
|
94 |
<td>snoopy.nceas.ucsb.edu</td> |
|
95 |
<td> |
|
96 |
<table border="2"> |
|
97 |
<tr> |
|
98 |
<td><b>server</b></td> |
|
99 |
<td><b>last_checked</b></td> |
|
100 |
<td><b>replicate</b></td> |
|
101 |
</tr> |
|
102 |
<tr> |
|
103 |
<td>localhost</td> |
|
104 |
<td>null</td> |
|
105 |
<td>0</td> |
|
106 |
</tr> |
|
107 |
<tr> |
|
108 |
<td>alpha.nceas.ucsb.edu:8080/berkley/servlet/replication </td> |
|
109 |
<td>2001-01-22 14:52:12.1</td> |
|
110 |
<td>1</td> |
|
111 |
</tr> |
|
112 |
<tr> |
|
113 |
<td>dev.nceas.ucsb.edu/Metacat/servlet/replication</td> |
|
114 |
<td>2001-01-23 9:10:02.5</td> |
|
115 |
<td>1</td> |
|
116 |
</tr> |
|
117 |
</table> |
|
118 |
</td> |
|
119 |
</tr> |
|
120 |
<tr> |
|
121 |
<td>alpha.nceas.ucsb.edu</td> |
|
122 |
<td> |
|
123 |
<table border="2"> |
|
124 |
<tr> |
|
125 |
<td><b>server</b></td> |
|
126 |
<td><b>last_checked</b></td> |
|
127 |
<td><b>replicate</b></td> |
|
128 |
</tr> |
|
129 |
<tr> |
|
130 |
<td>localhost</td> |
|
131 |
<td>null</td> |
|
132 |
<td>0</td> |
|
133 |
</tr> |
|
134 |
<tr> |
|
135 |
<td>snoopy.nceas.ucsb.edu:8080/berkley/servlet/replication</td> |
|
136 |
<td>2001-01-21 11:33:12.7</td> |
|
137 |
<td>0</td> |
|
138 |
</tr> |
|
139 |
<tr> |
|
140 |
<td>dev.nceas.ucsb.edu/Metacat/servlet/replication</td> |
|
141 |
<td>2001-01-23 10:22:02.5</td> |
|
142 |
<td>1</td> |
|
143 |
</tr> |
|
144 |
</table> |
|
145 |
</td> |
|
146 |
</tr> |
|
147 |
<tr> |
|
148 |
<td>dev.nceas.ucsb.edu</td> |
|
149 |
<td> |
|
150 |
<table border="2"> |
|
151 |
<tr> |
|
152 |
<td><b>server</b></td> |
|
153 |
<td><b>last_checked</b></td> |
|
154 |
<td><b>replicate</b></td> |
|
155 |
</tr> |
|
156 |
<tr> |
|
157 |
<td>localhost</td> |
|
158 |
<td>null</td> |
|
159 |
<td>0</td> |
|
160 |
</tr> |
|
161 |
<tr> |
|
162 |
<td>snoopy.nceas.ucsb.edu:8080/berkley/servlet/replication</td> |
|
163 |
<td>2001-01-21 11:33:12.7</td> |
|
164 |
<td>0</td> |
|
165 |
</tr> |
|
166 |
<tr> |
|
167 |
<td>alpha.nceas.ucsb.edu:8080/Metacat/servlet/replication</td> |
|
168 |
<td>2001-01-22 12:15:32.5</td> |
|
169 |
<td>1</td> |
|
170 |
</tr> |
|
171 |
</table> |
|
172 |
</td> |
|
173 |
</tr> |
|
174 |
</table> |
|
175 |
<p>Our three servers, snoopy, alpha and dev are all set up to replicate |
|
176 |
between themselves. Snoopy is a one way replicator. Meaning that it only |
|
177 |
pushes data to alpha and dev but does not pull back from them. This |
|
178 |
is achieved by dev and alpha setting snoopy's 'replicate' value to 0 indicating |
|
179 |
that they do not want to send their files to snoopy. Alpha and dev have a |
|
180 |
two-way replication agreement since each of them have a 1 in their 'replicate' |
|
181 |
value for the other.</p> |
|
182 |
<p>There is an html control panel for controling replication. After |
|
183 |
<a href="./Metacatinstall.html">installing</a> Metacat, you can access |
|
184 |
it by going through the Metacat servlet context you have setup and calling up |
|
185 |
replControl.html. For instance, if you setup a Metacat servlet instance |
|
186 |
called 'Metacat' you would probably type |
|
187 |
http://server.domain.com:8080/Metacat/replControl.html. The control panel |
|
188 |
is an easy interface for adding/removing/altering servers and starting the |
|
189 |
delta-T handler. It will also allow you to 'force replicate' your server list. |
|
190 |
This is useful if you want to initialize the state of one Metacat server |
|
191 |
from an existing state of another (i.e. copy all of the data from an existing |
|
192 |
server).</p> |
|
193 |
|
|
194 |
<br> |
|
195 |
<a href="./packages.html">Back</a> | <a href="./metacattour.html">Home</a> | |
|
196 |
<a href="./datafiles.html">Next</a> |
|
197 |
|
|
198 |
|
|
199 |
</BODY> |
|
200 |
</HTML> |
|
0 | 201 |
docs/user/metacatdom.html | ||
---|---|---|
1 |
<!-- |
|
2 |
* Metacatdom.html |
|
3 |
* |
|
4 |
* Authors: Jivka Bojilova |
|
5 |
* Copyright: 2000 Regents of the University of California and the |
|
6 |
* National Center for Ecological Analysis and Synthesis |
|
7 |
* For Details: http://www.nceas.ucsb.edu/ |
|
8 |
* Created: 2000 April 5 |
|
9 |
* Version: 0.01 |
|
10 |
* File Info: '$Id$' |
|
11 |
* |
|
12 |
* October Meeting SDSC, 2000 |
|
13 |
--> |
|
14 |
<HTML> |
|
15 |
<HEAD> |
|
16 |
<TITLE>Metacat</TITLE> |
|
17 |
<link rel="stylesheet" type="text/css" href="@docrooturl@default.css"> |
|
18 |
</HEAD> |
|
19 |
<BODY> |
|
20 |
<table width="100%"> |
|
21 |
<tr> |
|
22 |
<td class="tablehead" colspan="2"><p class="label">The Metacat DOM</p></td> |
|
23 |
<td class="tablehead" colspan="2" align="right"> |
|
24 |
<a href="./metacatdb.html">Back</a> | <a href="./metacattour.html">Home</a> | |
|
25 |
<a href="./metacatload.html">Next</a> |
|
26 |
</td> |
|
27 |
</tr> |
|
28 |
</table> |
|
29 |
<P>In the Metacat DOM implementation XML documents |
|
30 |
are disassembled in their composing nodes. All nodes are stored as records |
|
31 |
in relational database tables. The structure of each XML document is preserved |
|
32 |
by saving parent-child relationship between the nodes. |
|
33 |
<ul> |
|
34 |
<li> Each XML document in the Metacat database starts with one root node of |
|
35 |
type DOCUMENT. All other nodes in the document are its children. |
|
36 |
The document node can |
|
37 |
have multiple COMMENT or PI (processing instruction) nodes and only |
|
38 |
one ELEMENT node. The element node is the root node of the document and will |
|
39 |
be pointed to by all of its children. |
|
40 |
<li> Each node is described as a single record in the <i>xml_nodes</i> table. |
|
41 |
All nodes have a unique System ID (<i>nodeid</i>). Each node stores |
|
42 |
the ID of |
|
43 |
its direct parent (in <i>parentnodeid</i>), the ID of its documents root node |
|
44 |
(in <i>rootnodeid</i>) and its Document ID (<i>docid</i>). |
|
45 |
<li> Document attributes (such as docid, doctype, etc.) are stored in |
|
46 |
the xml_documents table. |
|
47 |
<li> Unimplemented DOM features: |
|
48 |
<ul> |
|
49 |
<li> Node types: Doctype, Entity, EntityReference, Notation. |
|
50 |
<li> Persistant DOM interface. This would allow a DOM compliant |
|
51 |
editor to work with an xml document in the database as if it were |
|
52 |
in memory. |
|
53 |
<li>Object Oriented representation of each node. |
|
54 |
</ul> |
|
55 |
</ul> |
|
56 |
<P> <img alt="Entity Relationship Diagram of the Metacat DOM" src="metacatdom.jpg"> |
|
57 |
|
|
58 |
<br> |
|
59 |
<a href="./metacatdb.html">Back</a> | <a href="./metacattour.html">Home</a> | |
|
60 |
<a href="./metacatload.html">Next</a> |
|
61 |
</BODY> |
|
62 |
</HTML> |
|
63 |
|
|
0 | 64 |
docs/user/xmltree.html | ||
---|---|---|
1 |
<!-- |
|
2 |
* xmltree.html |
|
3 |
* |
|
4 |
* Authors: Jivka Bojilova |
|
5 |
* Copyright: 2000 Regents of the University of California and the |
|
6 |
* National Center for Ecological Analysis and Synthesis |
|
7 |
* For Details: http://www.nceas.ucsb.edu/ |
|
8 |
* Created: 2000 April 5 |
|
9 |
* Version: 0.01 |
|
10 |
* File Info: '$Id$' |
|
11 |
* |
|
12 |
* October Meeting SDSC, 2000 |
|
13 |
--> |
|
14 |
<HTML> |
|
15 |
<HEAD> |
|
16 |
<TITLE>Metacat</TITLE> |
|
17 |
<link rel="stylesheet" type="text/css" href="@docrooturl@default.css"> |
|
18 |
</HEAD> |
|
19 |
<BODY> |
|
20 |
<table width="100%"> |
|
21 |
<tr> |
|
22 |
<td class="tablehead" colspan="2"><p class="label">XML Tree</p></td> |
|
23 |
<td class="tablehead" colspan="2" align="right"> |
|
24 |
<a href="./xmldoc.html">Back</a> | <a href="./metacattour.html">Home</a> | |
|
25 |
<a href="./domapi.html">Next</a> |
|
26 |
</td> |
|
27 |
</tr> |
|
28 |
</table> |
|
29 |
<p>The structure of an XML document can be represented visually as a tree.</p> |
|
30 |
<P> <img alt="tree representation of an xml document" src="xmltree.gif"> |
|
31 |
<br> |
|
32 |
<a href="./xmldoc.html">Back</a> | <a href="./metacattour.html">Home</a> | |
|
33 |
<a href="./domapi.html">Next</a> |
|
34 |
</BODY> |
|
35 |
</HTML> |
|
36 |
|
|
0 | 37 |
docs/user/unimplem.html | ||
---|---|---|
1 |
<!-- |
|
2 |
* unimplem.html |
|
3 |
* |
|
4 |
* Authors: Jivka Bojilova |
|
5 |
* Copyright: 2000 Regents of the University of California and the |
|
6 |
* National Center for Ecological Analysis and Synthesis |
|
7 |
* For Details: http://www.nceas.ucsb.edu/ |
|
8 |
* Created: 2000 April 5 |
|
9 |
* Version: 0.01 |
|
10 |
* File Info: '$Id$' |
|
11 |
* |
|
12 |
* October Meeting SDSC, 2000 |
|
13 |
--> |
|
14 |
<HTML> |
|
15 |
<HEAD> |
|
16 |
<TITLE>Metacat</TITLE> |
|
17 |
<link rel="stylesheet" type="text/css" href="@docrooturl@default.css"> |
|
18 |
</HEAD> |
|
19 |
<BODY> |
|
20 |
<table width="100%"> |
|
21 |
<tr> |
|
22 |
<td class="tablehead" colspan="2"><p class="label">Wishlist</p></td> |
|
23 |
<td class="tablehead" colspan="2" align="right"> |
|
24 |
<a href="./properties.html">Back</a> | <a href="./metacattour.html">Home</a> |
|
25 |
</td> |
|
26 |
</tr> |
|
27 |
</table> |
|
28 |
<UL> |
|
29 |
<LI> DOM API for Metacat Server. |
|
30 |
<LI> Split xml_nodes table in many tables for every doctype. |
|
31 |
<LI> Optimization of different operations. |
|
32 |
<LI> Mapping and convertion between metadata standarts. |
|
33 |
</UL> |
|
34 |
|
|
35 |
<br> |
|
36 |
<a href="./properties.html">Back</a> | <a href="./metacattour.html">Home</a> |
|
37 |
|
|
38 |
|
|
39 |
</BODY> |
|
40 |
</HTML> |
|
41 |
|
|
0 | 42 |
docs/user/entries-refs.ldif | ||
---|---|---|
1 |
#The referral to LTER's subtree |
|
2 |
dn: o=LTER,dc=ecoinformatics,dc=org |
|
3 |
objectclass: top |
|
4 |
objectclass: organization |
|
5 |
objectClass: referral |
|
6 |
objectclass: extensibleObject |
|
7 |
o: LTER |
|
8 |
description: referral to LTER's KNB subtree |
|
9 |
ref: ldap://alpha.nceas.ucsb.edu/o=LTER,dc=ecoinformatics,dc=org |
|
10 |
|
|
0 | 11 |
docs/user/entries-groups.ldif | ||
---|---|---|
1 |
# KNB development group at NCEAS |
|
2 |
dn: cn=knb-dev,o=NCEAS,dc=ecoinformatics,dc=org |
|
3 |
objectClass: top |
|
4 |
objectclass: groupOfUniqueNames |
|
5 |
cn: knb-dev |
|
6 |
uniqueMember: uid=bojilova,o=NCEAS,dc=ecoinformatics,dc=org |
|
7 |
uniqueMember: uid=berkley,o=NCEAS,dc=ecoinformatics,dc=org |
|
8 |
uniqueMember: uid=jones,o=NCEAS,dc=ecoinformatics,dc=org |
|
9 |
uniqueMember: uid=higgins,o=NCEAS,dc=ecoinformatics,dc=org |
|
10 |
uniqueMember: uid=harris,o=NCEAS,dc=ecoinformatics,dc=org |
|
11 |
description: KNB development group at NCEAS |
|
0 | 12 |
docs/user/metacatapi.html | ||
---|---|---|
1 |
<!-- |
|
2 |
* Metacatapi.html |
|
3 |
* |
|
4 |
* Authors: Jivka Bojilova |
|
5 |
* Copyright: 2000 Regents of the University of California and the |
|
6 |
* National Center for Ecological Analysis and Synthesis |
|
7 |
* For Details: http://www.nceas.ucsb.edu/ |
|
8 |
* Created: 2000 April 5 |
|
9 |
* Version: 0.01 |
|
10 |
* File Info: '$Id$' |
|
11 |
* |
|
12 |
* October Meeting SDSC, 2000 |
|
13 |
--> |
|
14 |
<HTML> |
|
15 |
<HEAD> |
|
16 |
<TITLE>Metacat</TITLE> |
|
17 |
<link rel="stylesheet" type="text/css" href="@docrooturl@default.css"> |
|
18 |
</HEAD> |
|
19 |
<BODY> |
|
20 |
<table width="100%"> |
|
21 |
<tr> |
|
22 |
<td class="tablehead" colspan="2"><p class="label">Metacat High Level API</p></td> |
|
23 |
<td class="tablehead" colspan="2" align="right"> |
|
24 |
<a href="./metacatout.html">Back</a> | <a href="./metacattour.html">Home</a> | |
|
25 |
<a href="./packages.html">Next</a> |
|
26 |
</td> |
|
27 |
</tr> |
|
28 |
</table> |
|
29 |
<p> |
|
30 |
<b>Multiple client interface</b> <br> |
|
31 |
Since Metacat Servlet is a subclass of HttpServlet, this allows any client |
|
32 |
to communicate with Metacat by essentially passing a URL with embedded |
|
33 |
servlet parameters. |
|
34 |
Metacat Servlet provides an HTTP Interface and can handle GET and POST |
|
35 |
requests. HTTP requests are sent from the the Client application and contain |
|
36 |
a number of parameters. These parameters, in form of name/value pairs, provide |
|
37 |
input data for the Servlet and also provide the Servlet any extra information it |
|
38 |
needs to handle the request. </p> |
|
39 |
<P> <b>Extensions of HttpServlet</b> <br> |
|
40 |
Metacat Server adds the functionality for writing, quering, and reading of |
|
41 |
XML stored in the Metacat Database as well functions for validating and |
|
42 |
transforming XML documents. </p> |
|
43 |
<b>MetacatServlet Parameters</b> |
|
44 |
<table border="1"> |
|
45 |
<tr> |
|
46 |
<td><b>Action</b></td> |
|
47 |
<td><b>Supplemental Parameters</b></td> |
|
48 |
<td><b>Description</b></td> |
|
49 |
</tr> |
|
50 |
<tr> |
|
51 |
<td>login</td> |
|
52 |
<td> |
|
53 |
<ul> |
|
54 |
<li>username - the user's login name</li> |
|
55 |
<li>password - the user's password</li> |
|
56 |
</ul> |
|
57 |
</td> |
|
58 |
<td>Log the user in.</td> |
|
59 |
</tr> |
|
60 |
<tr> |
|
61 |
<td>logout</td> |
|
62 |
<td>none</td> |
|
63 |
<td>Log the current user out and destroy the associated session.</td> |
|
64 |
</tr> |
|
65 |
<tr> |
|
66 |
<td>query</td> |
|
67 |
<td> |
|
68 |
<ul> |
|
69 |
<li>returndoctype - the doctype that you wish to use for your |
|
70 |
<a href="./packages.html">Package View</a></li> |
|
71 |
<li>qformat - the format that you wish to return the resultset in. |
|
72 |
Possible values are 'html' or 'xml'.</li> |
|
73 |
<li>querytitle - OPTIONAL - the title of the query</li> |
|
74 |
<li>doctype - OPTIONAL - if doctype is specified, the search is limited |
|
75 |
only to the doctype(s) specified.</li> |
|
76 |
<li>returnfield - a custom field to be returned by any hit document. |
|
77 |
This is explained in more detail in <a href="./metacatquery.html"> |
|
78 |
Queries and Results</a>.</li> |
|
79 |
<li>operator - the boolean operator to apply to the query - Possible |
|
80 |
values are: UNION or INTERSECT</li> |
|
81 |
<li>searchmode - the type of search to be performed. Possible values |
|
82 |
are: contains, starts-with, ends-with, equals, isnot-equal, greater-than, |
|
83 |
less-than, greater-than-equals, less-than-equals.</li> |
|
84 |
<li>anyfield - a freetext search variable. A value placed in this |
|
85 |
parameter will be searched for in any document in any node.</li> |
|
86 |
</ul> |
|
87 |
</td> |
|
88 |
<td>Perform a free text query.</td> |
|
89 |
</tr> |
|
90 |
<tr> |
|
91 |
<td>squery</td> |
|
92 |
<td> |
|
93 |
<ul> |
|
94 |
<li>query - the text of the pathquery document that is being sent to the |
|
95 |
server</li> |
|
96 |
</ul> |
|
97 |
</td> |
|
98 |
<td>Perform a structured query.</td> |
|
99 |
</tr> |
|
100 |
<tr> |
|
101 |
<td>read</td> |
|
102 |
<td> |
|
103 |
<ul> |
|
104 |
<li>docid - the docid of the document to read</li> |
|
105 |
<li>qformat - the format to return the document in. Possible values |
|
106 |
are: html, xml</li> |
|
107 |
</ul> |
|
108 |
</td> |
|
109 |
<td>Get docid from the database and return it in qformat form.</td> |
|
110 |
</tr> |
|
111 |
<tr> |
|
112 |
<td>insert</td> |
|
113 |
<td> |
|
114 |
<ul> |
|
115 |
<li>docid - the user defined docid to assign to the new document.</li> |
|
116 |
<li>doctext - the text of the document to insert</li> |
|
117 |
</ul> |
|
118 |
</td> |
|
119 |
<td>Insert doctext into the database.</td> |
|
120 |
</tr> |
|
121 |
<tr> |
|
122 |
<td>update</td> |
|
123 |
<td> |
|
124 |
<ul> |
|
125 |
<li>docid - the docid of the document to update</li> |
|
126 |
<li>doctext - the text with which to update the document</li> |
|
127 |
</ul> |
|
128 |
</td> |
|
129 |
<td>Overwrite a document with a new one and give the new one |
|
130 |
the same docid but with next revision number.</td> |
|
131 |
</tr> |
|
132 |
<tr> |
|
133 |
<td>delete</td> |
|
134 |
<td> |
|
135 |
<ul> |
|
136 |
<li>docid - the docid of the document to delete</li> |
|
137 |
</ul> |
|
138 |
</td> |
|
139 |
<td>Delete the specified docid from the database.</td> |
|
140 |
</tr> |
|
141 |
<tr> |
|
142 |
<td>validate</td> |
|
143 |
<td> |
|
144 |
<ul> |
|
145 |
<li>docid - the docid of the document to validate</li> |
|
146 |
<li>valtext - the DTD by which to validate this document</li> |
|
147 |
</ul> |
|
148 |
</td> |
|
149 |
<td>Validate docid against its DTD.</td> |
|
150 |
</tr> |
|
151 |
<tr> |
|
152 |
<td>getaccesscontrol</td> |
|
153 |
<td> |
|
154 |
<ul> |
|
155 |
<li>docid - the docid of the document to get the ACL for</li> |
|
156 |
</ul> |
|
157 |
</td> |
|
158 |
<td>Get ACL for document with that docid</td> |
|
159 |
</tr> |
|
160 |
<tr> |
|
161 |
<td>getprincipals</td> |
|
162 |
<td>none</td> |
|
163 |
<td>Get all users and groups in the current authentication schema</td> |
|
164 |
</tr> |
|
165 |
<tr> |
|
166 |
<td>getdoctypes</td> |
|
167 |
<td>none</td> |
|
168 |
<td>Get all doctypes currently available in Metacat Catalog System.</td> |
|
169 |
</tr> |
|
170 |
<tr> |
|
171 |
<td>getdtdschema</td> |
|
172 |
<td> |
|
173 |
<ul> |
|
174 |
<li>doctype - the doctype which DTD or XMLSchema file to read.</td> |
|
175 |
</ul> |
|
176 |
</td> |
|
177 |
<td>Read DTD or XMLSchema file for the specified doctype.</td> |
|
178 |
</tr> |
|
179 |
<tr> |
|
180 |
<td>getdataguide</td> |
|
181 |
<td> |
|
182 |
<ul> |
|
183 |
<li>doctype - the doctype for which to get the data guide</li> <br> |
|
184 |
<i><b> Deprecated. </b></i> Use getdtdschema action instead. |
|
185 |
</ul> |
|
186 |
</td> |
|
187 |
<td>Read a dataguide for doctype.</td> |
|
188 |
</tr> |
|
189 |
<tr> |
|
190 |
<td>getlastdocid</td> |
|
191 |
<td> |
|
192 |
<ul> |
|
193 |
<li>username - the user's login name which last docid to get.</td> |
|
194 |
</ul> |
|
195 |
</td> |
|
196 |
<td>Get the latest docid with rev number used by user.</td> |
|
197 |
</tr> |
|
198 |
<tr> |
|
199 |
<td>protocoltest</td> |
|
200 |
<td> |
|
201 |
<ul> |
|
202 |
<li>url - the url to test against the protocol handler</li> |
|
203 |
</ul> |
|
204 |
</td> |
|
205 |
<td>Test the protocol handlers installed for metacat:// URLs.</td> |
|
206 |
</tr> |
|
207 |
</table> |
|
208 |
|
|
209 |
<!-- |
|
210 |
<TABLE border=1 width=700> |
|
211 |
<TR> |
|
212 |
<TH WIDTH="50%">Metacat Server Interface functions</TH> |
|
213 |
<TH WIDTH="50%">Parameter list</TH> |
|
214 |
<TR> |
|
215 |
<TD><small>Structured query search through Metacat DB </TD> |
|
216 |
<TD><small>action=squery <br> |
|
217 |
query <br> |
|
218 |
returndoc <br> |
|
219 |
username <br> |
|
220 |
groupname </TD> |
|
221 |
<TR> |
|
222 |
<TD><small>Structured query search. Query parts provided in the parameter |
|
223 |
list </TD> |
|
224 |
<TD><small>action=query <br> |
|
225 |
meta_file_id <br> |
|
226 |
querytitle <br> |
|
227 |
doctype <br> |
|
228 |
returnfield <br> |
|
229 |
operator <br> |
|
230 |
casesensitive <br> |
|
231 |
searchmode <br> |
|
232 |
anyfield </TD> |
|
233 |
<TR> |
|
234 |
<TD><small> Read XML document from Metacat DB, transform into qformat |
|
235 |
and return it </TD> |
|
236 |
<TD><small> action=read <br> |
|
237 |
docid <br> |
|
238 |
qformat </TD> |
|
239 |
<TR> |
|
240 |
<TD><small> Read XML document <br> |
|
241 |
- from Metacat DB if url=Metacat://... <br> |
|
242 |
- from Internet if url=http:// <br> |
|
243 |
Transform into qformat and return it </TD> |
|
244 |
<TD><small> action=read <br> |
|
245 |
docid <br> |
|
246 |
qformat </TD> |
|
247 |
<TR> |
|
248 |
<TD><small> Read abstract data of a document and return it </TD> |
|
249 |
<TD><small> action=getabstract <br> |
|
250 |
abstractpath <br> |
|
251 |
docid </TD> |
|
252 |
<TR> |
|
253 |
<TD><small> Write XML document into Metacat DB </TD> |
|
254 |
<TD><small> action=insert <br> |
|
255 |
docid <br> |
|
256 |
doctext <br> |
|
257 |
username <br> |
|
258 |
groupname </TD> |
|
259 |
<TR> |
|
260 |
<TD><small> Modify existing in Metacat Db XML document with new content |
|
261 |
provided </TD> |
|
262 |
<TD><small> action=update <br> |
|
263 |
docid <br> |
|
264 |
doctext <br> |
|
265 |
username <br> |
|
266 |
groupname </TD> |
|
267 |
<TR> |
|
268 |
<TD><small> Delete existing in Metacat Db XML document </TD> |
|
269 |
<TD><small> action=delete <br> |
|
270 |
docid <br> |
|
271 |
username <br> |
|
272 |
groupname </TD> |
|
273 |
<TR> |
|
274 |
<TD><small> Validate XML document </TD> |
|
275 |
<TD><small> action=validate <br> |
|
276 |
docid <br> |
|
277 |
valtext <br> |
|
278 |
username <br> |
|
279 |
groupname </TD> |
|
280 |
<TR> |
|
281 |
<TD><small> Read XML document from Metacat Db and related documents if |
|
282 |
they exist and return them in zip file </TD> |
|
283 |
<TD><small> action=getdatadoc <br> |
|
284 |
docid <br> |
|
285 |
relation </TD> |
|
286 |
<TR> |
|
287 |
<TD><small> Read all different document types currently available in |
|
288 |
Metacat Db </TD> |
|
289 |
<TD><small> action=getdoctypes </TD> |
|
290 |
<TR> |
|
291 |
<TD><small> Read Data Guide for specified doctype </TD> |
|
292 |
<TD><small> action=getdataguide <br> |
|
293 |
doctype </TD> |
|
294 |
<TR> |
|
295 |
<TD><small> Login to Metacat Server </TD> |
|
296 |
<TD><small> action=login <br> |
|
297 |
username <br> |
|
298 |
password </TD> |
|
299 |
<TR> |
|
300 |
<TD><small> Logout from Metacat Server </TD> |
|
301 |
<TD><small> action=logout </TD> |
|
302 |
</TABLE> |
|
303 |
|
|
304 |
<P><b>HTTP parameters for Metacat Server </b> |
|
305 |
<TABLE border=1> |
|
306 |
<TR> |
|
307 |
<TH>Name</TH> |
|
308 |
<TH>Value</TH> |
|
309 |
<TR> |
|
310 |
<TD VALIGN=TOP> action</TD> |
|
311 |
<TD> squery <br> |
|
312 |
query <br> |
|
313 |
getdocument <br> |
|
314 |
getrelateddocument <br> |
|
315 |
getabstract <br> |
|
316 |
insert <br> |
|
317 |
update <br> |
|
318 |
delete <br> |
|
319 |
validate <br> |
|
320 |
getdatadoc <br> |
|
321 |
getdoctypes <br> |
|
322 |
getdataguide <br> |
|
323 |
login <br> |
|
324 |
logout </TD> |
|
325 |
<TR> |
|
326 |
<TD> query</TD> |
|
327 |
<TD> <i>XML text of query that conforms to pathquery.dtd</i> </TD> |
|
328 |
<TR> |
|
329 |
<TD> returndoc</TD> |
|
330 |
<TD> <i>array of doctypes to backtrack against</i> </TD> |
|
331 |
<TR> |
|
332 |
<TD> doctype</TD> |
|
333 |
<TD> <i>document type list</i> </TD> |
|
334 |
<TR> |
|
335 |
<TD> docid</TD> |
|
336 |
<TD> <i>docid of document</i></TD> |
|
337 |
<TR> |
|
338 |
<TD> doctext</TD> |
|
339 |
<TD> <i>XML text of document to be load into db</i> </TD> |
|
340 |
<TR> |
|
341 |
<TD> valtext</TD> |
|
342 |
<TD> <i>XML text of document to be validated</i> </TD> |
|
343 |
<TR> |
|
344 |
<TD> abstractpath</TD> |
|
345 |
<TD> <i>XML path to the abstract node to be read</i> </TD> |
|
346 |
<TR> |
|
347 |
<TD> url</TD> |
|
348 |
<TD> <i>URL to document. It can be of type Metacat or http</i> </TD> |
|
349 |
<TR> |
|
350 |
<TD> relation</TD> |
|
351 |
<TD> <i>List of URLs to documents. They can be of type Metacat or |
|
352 |
http</i> </TD> |
|
353 |
<TR> |
|
354 |
<TD> qformat</TD> |
|
355 |
<TD> xml <br> html </TD> |
|
356 |
<TR> |
|
357 |
<TD> username</TD> |
|
358 |
<TD> <i>username for authentication and connection to the server</i></TD> |
|
359 |
<TR> |
|
360 |
<TD> password</TD> |
|
361 |
<TD> <i>user's password for authentication</i> </TD> |
|
362 |
</TABLE> |
|
363 |
--> |
|
364 |
<br> |
|
365 |
<b><a href="./replication.html">MetacatReplication</a> Parameters</b> |
|
366 |
<table border="1"> |
|
367 |
<tr> |
|
368 |
<td><b>Action</b></td> |
|
369 |
<td><b>Supplemental Parameters</b></td> |
|
370 |
<td><b>Description</b></td> |
|
371 |
</tr> |
|
372 |
<tr> |
|
373 |
<td>forcereplicate</td> |
|
374 |
<td> |
|
375 |
<ul> |
|
376 |
<li>server - The server to which this document is being sent</li> |
|
377 |
<li>docid - The docid of the document to send</li> |
|
378 |
<li>dbaction - DEFAULTS TO UPDATE - The action to perform on the |
|
379 |
document. INSERT or UPDATE.</li> |
|
380 |
</ul> |
|
381 |
</td> |
|
382 |
<td>Force this server to get docid from the remote host.</td> |
|
383 |
</tr> |
|
384 |
<tr> |
|
385 |
<td>getall</td> |
|
386 |
<td>none</td> |
|
387 |
<td>Forces the local server to check all known servers for updated |
|
388 |
documents.</td> |
|
389 |
</tr> |
|
390 |
<tr> |
|
391 |
<td>getcatalog</td> |
|
392 |
<td>none</td> |
|
393 |
<td>Sends the contents of the xml_catalog table encoded in XML.</td> |
|
394 |
</tr> |
|
395 |
<tr> |
|
396 |
<td>getlock</td> |
|
397 |
<td> |
|
398 |
<ul> |
|
399 |
<li>docid - the docid to get the lock for</li> |
|
400 |
<li>updaterev - the revision number of docid</li> |
|
401 |
</ul> |
|
402 |
</td> |
|
403 |
<td>Request a lock on docid.</td> |
|
404 |
</tr> |
|
405 |
<tr> |
|
406 |
<td>gettime</td> |
|
407 |
<td>none</td> |
|
408 |
<td>Return the local time on this server.</td> |
|
409 |
</tr> |
|
410 |
<tr> |
|
411 |
<td>servercontrol</td> |
|
412 |
<td> |
|
413 |
<ul> |
|
414 |
<li>subaction - The replication control to be performed. Possible |
|
415 |
values: |
|
416 |
<ul> |
|
417 |
<li>add - add a new server to the replication list</li> |
|
418 |
<li>delete - remove a server from the replication list</li> |
|
419 |
<li>list - list all of the servers currently in the server list</li> |
|
420 |
</ul> |
|
421 |
<li>replicate - a boolean flag (1 or 0) which determines if this |
|
422 |
server is to copy files from the newly added server.</li> |
|
423 |
<li>server - the server to add/delete</li> |
|
424 |
</ul> |
|
425 |
</td> |
|
426 |
<td>Perform subaction on the Replication daemon.</td> |
|
427 |
</tr> |
|
428 |
<tr> |
|
429 |
<td>read</td> |
|
430 |
<td> |
|
431 |
<ul> |
|
432 |
<li>docid - the docid to read</li> |
|
433 |
</ul> |
|
434 |
</td> |
|
435 |
<td>Sends docid to the remote host.</td> |
|
436 |
</tr> |
|
437 |
<tr> |
|
438 |
<td>start</td> |
|
439 |
<td> |
|
440 |
<ul> |
|
441 |
<li>rate - DEFAULTS TO 1000 - The rate (in seconds) at which you want |
|
442 |
the replication daemon to check for updated documents. The value |
|
443 |
cannot be less than 30.</li> |
|
444 |
</ul> |
|
445 |
</td> |
|
446 |
<td>Start the Replication daemon with a time interval of deltaT.</td> |
|
447 |
</tr> |
|
448 |
<tr> |
|
449 |
<td>stop</td> |
|
450 |
<td>none</td> |
|
451 |
<td>Stop the Replication daemon.</td> |
|
452 |
</tr> |
|
453 |
<tr> |
|
454 |
<td>update</td> |
|
455 |
<td>none</td> |
Also available in: Unified diff
moving metacat docs to xmltodb