001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements. See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership. The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the  "License");
007     * you may not use this file except in compliance with the License.
008     * You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing, software
013     * distributed under the License is distributed on an "AS IS" BASIS,
014     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    /*
019     * $Id: DOMOrder.java 468655 2006-10-28 07:12:06Z minchau $
020     */
021    package org.apache.xml.utils;
022    
023    /**
024     * @deprecated Since the introduction of the DTM, this class will be removed.
025     * Nodes that implement this index can return a document order index.
026     * Eventually, this will be replaced by DOM 3 methods. 
027     * (compareDocumentOrder and/or compareTreePosition.)
028     */
029    public interface DOMOrder
030    {
031    
032      /**
033       * Get the UID (document order index).
034       *
035       * @return integer whose relative value corresponds to document order
036       * -- that is, if node1.getUid()<node2.getUid(), node1 comes before
037       * node2, and if they're equal node1 and node2 are the same node. No
038       * promises are made beyond that.
039       */
040      public int getUid();
041    }