CollectionMetadata


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  ;
26  
27  import org.xquark.xpath.XTree;
28  
29  /**
30   * Interface that provides a common access to the metadata of a collection
31   * in an XML data source.
32   */
33  public interface CollectionMetadata {
34  
35      /**
36       * Accessor to the collection name.
37       * @return String
38       */
39      public String   getCollectionName();
40  
41      /**
42       * Accessor to the collection main metadata as an XPath data model tree
43       * with potential XMLSchema type information.
44       * @return a memory structure which is in fact a tree which is based on
45       * the XPath data model.
46       */
47      public XTree getXTree();
48  
49      /**
50       * Accessor to the collection of root element declarations
51       * @return If colllection has restricted root element declarations returns them, otherwise null
52       */
53      public Collection   getRootNodes();
54  
55  }
56
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags