RowOrdering.java

/*
 * Copyright (c) 2011,2013 Big Switch Networks, Inc.
 *
 * Licensed under the Eclipse Public License, Version 1.0 (the
 * "License"); you may not use this file except in compliance with the
 * License. You may obtain a copy of the License at
 *
 *      http://www.eclipse.org/legal/epl-v10.html
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * permissions and limitations under the License.
 *
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *
 *    Originally created by David Erickson, Stanford University 
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the
 *    License. You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing,
 *    software distributed under the License is distributed on an "AS
 *    IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 *    express or implied. See the License for the specific language
 *    governing permissions and limitations under the License. 
 */

package org.sdnplatform.storage;

import java.util.ArrayList;
import java.util.List;

public class RowOrdering {
    
    public enum Direction { ASCENDING, DESCENDING };
    
    public class Item {
        
        private String column;
        private Direction direction;
        
        public Item(String column, Direction direction) {
            assert(column != null);
            assert(direction != null);
            this.column = column;
            this.direction = direction;
        }
        
        public String getColumn() {
            return column;
        }
        
        public Direction getDirection() {
            return direction;
        }

        @Override
        public int hashCode() {
            final int prime = 31;
            int result = 1;
            result = prime * result + getOuterType().hashCode();
            result = prime * result
                     + ((column == null) ? 0 : column.hashCode());
            result = prime * result
                     + ((direction == null) ? 0 : direction.hashCode());
            return result;
        }

        @Override
        public boolean equals(Object obj) {
            if (this == obj) return true;
            if (obj == null) return false;
            if (getClass() != obj.getClass()) return false;
            Item other = (Item) obj;
            if (!getOuterType().equals(other.getOuterType())) return false;
            if (column == null) {
                if (other.column != null) return false;
            } else if (!column.equals(other.column)) return false;
            if (direction != other.direction) return false;
            return true;
        }

        private RowOrdering getOuterType() {
            return RowOrdering.this;
        }
    }
    
    private List<Item> itemList = new ArrayList<Item>();
    
    public RowOrdering() {
    }
    
    public RowOrdering(String column) {
        add(column);
    }
    
    public RowOrdering(String column, Direction direction) {
        add(column, direction);
    }
    
    public RowOrdering(Item item) {
        add(item);
    }
    
    public RowOrdering(Item[] itemArray) {
        add(itemArray);
    }
    
    public RowOrdering(List<Item> itemList) {
        add(itemList);
    }
    
    public void add(String column) {
        itemList.add(new Item(column, Direction.ASCENDING));
    }
    
    public void add(String column, Direction direction) {
        itemList.add(new Item(column, direction));
    }
    
    public void add(Item item) {
        assert(item != null);
        itemList.add(item);
    }
    
    public void add(Item[] itemArray) {
        for (Item item: itemArray) {
            itemList.add(item);
        }
    }
    
    public void add(List<Item> itemList) {
        this.itemList.addAll(itemList);
    }
    
    public List<Item> getItemList() {
        return itemList;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result
                 + ((itemList == null) ? 0 : itemList.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) return true;
        if (obj == null) return false;
        if (getClass() != obj.getClass()) return false;
        RowOrdering other = (RowOrdering) obj;
        if (itemList == null) {
            if (other.itemList != null) return false;
        } else if (!itemList.equals(other.itemList)) return false;
        return true;
    }
}