KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > xquark > mapper > storage > PathIterator


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.mapper.storage;
24
25 import org.xquark.mapper.RepositoryException;
26 import org.xquark.mapper.metadata.StoragePathMetadata;
27 import org.xquark.xpath.PathExpr;
28
29
30
31 /** This interface is used by Filers of Repository & mapper.
32  */
33 public interface PathIterator
34 {
35  
36
37     
38     public void reset();
39     
40     /* Create a node if it does not exist without entering it */
41     public StoragePathMetadata createNode(String JavaDoc namespace, String JavaDoc localName, byte type)
42     throws RepositoryException;
43
44     /* Enter the specified node element or create it if does not exist */
45     public StoragePathMetadata push(String JavaDoc namespace, String JavaDoc localName)
46     throws RepositoryException;
47
48     public StoragePathMetadata pop();
49     
50     /** Return the absolute position of the locator.
51      * <p>i.e., !isDiscardable()</p>
52      */
53     public PathExpr getLocation();
54     
55     public StoragePathMetadata getStoragePathMetadata();
56 }
57
Popular Tags