com.avaje.ebean.bean.ObjectGraphNode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation
Ebean
There is a newer version: 2.8.1
/**
 * Copyright (C) 2006  Robin Bygrave
 * 
 * This file is part of Ebean.
 * 
 * Ebean is free software; you can redistribute it and/or modify it 
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *  
 * Ebean 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Ebean; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA  
 */
package com.avaje.ebean.bean;

import java.io.Serializable;


/**
 * Identifies a unique node of an object graph. 
 * 
 * It represents a location relative to the root of an object graph and specific to a
 * query and call stack hash.
 * 
 */
public final class ObjectGraphNode implements Serializable {

	private static final long serialVersionUID = 2087081778650228996L;

	/**
	 * Identifies the origin.
	 */
	private final ObjectGraphOrigin originQueryPoint;
	
	/**
	 * The path relative to the root.
	 */
	private final String path;
	
	/**
	 * Create at a sub level.
	 */
	public ObjectGraphNode(ObjectGraphNode parent, String path) {
		this.originQueryPoint = parent.getOriginQueryPoint();
		this.path = parent.getChildPath(path);
	}
	
	/**
	 * Create an the root level.
	 */
	public ObjectGraphNode(ObjectGraphOrigin originQueryPoint, String path) {
		this.originQueryPoint = originQueryPoint;
		this.path = path;
	}
	
	/**
	 * Return the origin query point.
	 */
	public ObjectGraphOrigin getOriginQueryPoint() {
		return originQueryPoint;
	}

	private String getChildPath(String childPath) {
		if (path == null){
			return childPath;
		} else if (childPath == null) {
			return path;
		} else {
			return path+"."+childPath;
		}
	}

	/**
	 * Return the path relative to the root.
	 */
	public String getPath() {
		return path;
	}

	public String toString() {
		return "origin:"+originQueryPoint+" "+":"+path+":"+path;
	}
}