ViewPath.java

/*
 * RHQ Management Platform
 * Copyright (C) 2005-2010 Red Hat, Inc.
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
package org.rhq.coregui.client;

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

/**
 * @author Greg Hinkle
 */
public class ViewPath {

    private List<ViewId> viewPath = new ArrayList<ViewId>();

    private int index = 0;

    private boolean refresh = false;

    public ViewPath() {
    }

    public ViewPath(String pathString) {
        this(pathString, false);
    }

    public ViewPath(String pathString, boolean refresh) {
        for (String pathElement : pathString.split("/")) {
            viewPath.add(new ViewId(pathElement));
        }
        this.refresh = refresh;
    }

    public List<ViewId> getViewPath() {
        return viewPath;
    }

    public String getParentViewPath() {
        return getPathToIndex(this.index - 1);
    }

    public ViewPath next() {
        index++;
        return this;
    }

    public ViewId getViewForIndex(int index) {
        return viewPath.get(index);
    }

    public int getCurrentAsInt() {
        return Integer.parseInt(getCurrent().getPath());
    }

    public ViewId getCurrent() {
        if (index >= viewPath.size()) {
            return null;
        } else {
            return viewPath.get(index);
        }
    }

    public int getCurrentIndex() {
        return index;
    }

    public String getPathToCurrent() {
        return getPathToIndex(this.index);
    }

    public String getPathToIndex(int endIndex) {
        String path = "";
        for (int i = 0; i < endIndex; i++) {
            if (i > 0) {
                path += "/";
            }
            path += this.viewPath.get(i).getPath();
        }
        return path;
    }

    public ViewId getNext() {
        return viewPath.get(index + 1);
    }

    public boolean isEnd() {
        return viewPath.size() <= index;
    }

    public boolean isCurrent(ViewId providedViewId) {
        return !(isEnd() || providedViewId == null || !getCurrent().equals(providedViewId));
    }

    public boolean isNext(ViewId providedViewId) {
        return ((index + 1) < viewPath.size() && providedViewId != null && getNext().equals(providedViewId));
    }

    public boolean isNextEnd() {
        return viewPath.size() <= index + 1;
    }

    public int viewsLeft() {
        return viewPath.size() - index - 1;
    }

    public boolean isRefresh() {
        return refresh;
    }

    public void setRefresh(boolean refresh) {
        this.refresh = refresh;
    }

    @Override
    public String toString() {
        String path = "";
        for (ViewId view : viewPath) {
            if (path.length() > 0) {
                path += "/";
            }
            path += view.getPath();
        }
        return path;
    }
}