01: /*
02: * Copyright 1999-2004 The Apache Software Foundation.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16: /*
17: * $Id: DOMOrder.java,v 1.3 2004/02/17 04:21:14 minchau Exp $
18: */
19: package org.apache.xml.utils;
20:
21: /**
22: * @deprecated Since the introduction of the DTM, this class will be removed.
23: * Nodes that implement this index can return a document order index.
24: * Eventually, this will be replaced by DOM 3 methods.
25: * (compareDocumentOrder and/or compareTreePosition.)
26: */
27: public interface DOMOrder {
28:
29: /**
30: * Get the UID (document order index).
31: *
32: * @return integer whose relative value corresponds to document order
33: * -- that is, if node1.getUid()<node2.getUid(), node1 comes before
34: * node2, and if they're equal node1 and node2 are the same node. No
35: * promises are made beyond that.
36: */
37: public int getUid();
38: }
|