19f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson/* 29f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Licensed to the Apache Software Foundation (ASF) under one 39f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * or more contributor license agreements. See the NOTICE file 49f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * distributed with this work for additional information 59f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * regarding copyright ownership. The ASF licenses this file 69f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * to you under the Apache License, Version 2.0 (the "License"); 79f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * you may not use this file except in compliance with the License. 89f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * You may obtain a copy of the License at 99f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 109f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * http://www.apache.org/licenses/LICENSE-2.0 119f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 129f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Unless required by applicable law or agreed to in writing, software 139f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * distributed under the License is distributed on an "AS IS" BASIS, 149f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 159f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * See the License for the specific language governing permissions and 169f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * limitations under the License. 179f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 189f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson/* 199f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * $Id: DOMOrder.java 468655 2006-10-28 07:12:06Z minchau $ 209f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 219f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonpackage org.apache.xml.utils; 229f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 239f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson/** 249f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @deprecated Since the introduction of the DTM, this class will be removed. 259f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Nodes that implement this index can return a document order index. 269f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Eventually, this will be replaced by DOM 3 methods. 279f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * (compareDocumentOrder and/or compareTreePosition.) 289f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 299f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonpublic interface DOMOrder 309f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson{ 319f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 329f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 339f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Get the UID (document order index). 349f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 359f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return integer whose relative value corresponds to document order 369f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * -- that is, if node1.getUid()<node2.getUid(), node1 comes before 379f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * node2, and if they're equal node1 and node2 are the same node. No 389f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * promises are made beyond that. 399f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 409f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public int getUid(); 419f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson} 42