001    //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/tags/2.1/src/org/deegree/ogcbase/IndexStep.java $
002    /*----------------    FILE HEADER  ------------------------------------------
003    
004     This file is part of deegree.
005     Copyright (C) 2001-2007 by:
006     EXSE, Department of Geography, University of Bonn
007     http://www.giub.uni-bonn.de/deegree/
008     lat/lon GmbH
009     http://www.lat-lon.de
010    
011     This library is free software; you can redistribute it and/or
012     modify it under the terms of the GNU Lesser General Public
013     License as published by the Free Software Foundation; either
014     version 2.1 of the License, or (at your option) any later version.
015    
016     This library is distributed in the hope that it will be useful,
017     but WITHOUT ANY WARRANTY; without even the implied warranty of
018     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
019     Lesser General Public License for more details.
020    
021     You should have received a copy of the GNU Lesser General Public
022     License along with this library; if not, write to the Free Software
023     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
024    
025     Contact:
026    
027     Andreas Poth
028     lat/lon GmbH
029     Aennchenstraße 19
030     53177 Bonn
031     Germany
032     E-Mail: poth@lat-lon.de
033    
034     Prof. Dr. Klaus Greve
035     Department of Geography
036     University of Bonn
037     Meckenheimer Allee 166
038     53115 Bonn
039     Germany
040     E-Mail: greve@giub.uni-bonn.de
041     
042     ---------------------------------------------------------------------------*/
043    package org.deegree.ogcbase;
044    
045    import org.deegree.datatypes.QualifiedName;
046    
047    /**
048     * {@link PropertyPathStep} implementation that selects a specified occurence of an element (using
049     * the element name as property name).
050     * 
051     * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider </a>
052     * @author last edited by: $Author: apoth $
053     * 
054     * @version $Revision: 6834 $, $Date: 2007-05-05 11:01:02 +0200 (Sa, 05 Mai 2007) $
055     * 
056     * @see PropertyPathStep
057     */
058    public class IndexStep extends PropertyPathStep {
059    
060        private int selectedIndex;
061    
062        /**
063         * Creates a new instance of <code>IndexStep</code> that selects the specified occurence of
064         * the element with the given name.
065         * 
066         * @param elementName
067         * @param selectedIndex
068         */
069        IndexStep( QualifiedName elementName, int selectedIndex ) {
070            super( elementName );
071            this.selectedIndex = selectedIndex;
072        }
073    
074        /**
075         * Returns the index of the selected element.
076         * 
077         * @return the index of the selected element
078         */
079        public int getSelectedIndex() {
080            return this.selectedIndex;
081        }
082    
083        @Override
084        public int hashCode() {
085            return this.selectedIndex + this.propertyName.hashCode();
086        }
087    
088        @Override
089        public boolean equals( Object obj ) {
090            if ( !( obj instanceof IndexStep ) ) {
091                return false;
092            }
093            IndexStep that = (IndexStep) obj;
094            return this.getSelectedIndex() == that.getSelectedIndex() && this.propertyName.equals( that.propertyName );
095        }
096    
097        @Override
098        public String toString() {
099            return this.propertyName.getPrefixedName() + "[" + this.selectedIndex + "]";
100        }
101    }