KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > xquark > xquery > metadata > resolver > SourceMetadata


1 /*
2  * This file belongs to the XQuark distribution.
3  * Copyright (C) 2003 Universite de Versailles Saint-Quentin.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307.
18  * You can also get it at http://www.gnu.org/licenses/lgpl.html
19  *
20  * For more information on this software, see http://www.xquark.org.
21  */
22
23 package org.xquark.xquery.metadata.resolver;
24
25 import java.util.Collection JavaDoc;
26
27 /**
28  * Interface that provides a common access to the metadata of an XML data
29  * source.
30  */
31 public interface SourceMetadata
32 {
33
34
35     
36     /**
37      * Returns a collection of metadata objects for all collections of the
38      * source.
39      * @return a Collection object containing CollectionMetadata objects.
40      */
41     public Collection JavaDoc getCollectionsMetadata();
42     
43     /** Provide access to a particular collection's metadata given by name.
44      * <B>Warning:</B> implementation must be consistent with the case flag
45      * , i.e., must be case unsensitive if the flag is false.
46      * @see #isCaseSensitive()
47      * @param collectionName the ID of the collection. Case is considered or not
48      * according to the case flag.
49      * @return a SourceMetadata object
50      */
51     public CollectionMetadata getCollectionMetadata(String JavaDoc collectionName);
52     
53     /**
54      * Accessor to the source name.
55      * @return the source symbolic name
56      */
57     public String JavaDoc getSourceName();
58     
59     /**
60      * Returns the value of the case flag. If false, the case of the collection
61      * name retrieved with the getCollections() method must be ignored.
62      * @see #isCaseSensitive()
63      * @see CollectionMetadata#getCollectionName()
64      * @return the value of the case flag.
65      */
66     public boolean isCaseSensitive();
67
68     /**
69      * Returns the value of the strict flag. If true, only those paths present in
70      * the metadata can be found, none can be extrapolated.
71      * @return the value of the strict flag.
72      */
73     public boolean isStrict();
74 }
75
Popular Tags