OTDatabase.java

/*
 *  Copyright (C) 2004  The Concord Consortium, Inc.,
 *  10 Concord Crossing, Concord, MA 01742
 *
 *  Web Site: http://www.concord.org
 *  Email: info@concord.org
 *
 *  This library 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.
 *
 *  This library 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 this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * END LICENSE */

/*
 * Last modification information:
 * $Revision: 1.15 $
 * $Date: 2007-07-22 04:49:00 $
 * $Author: scytacki $
 *
 * Licence Information
 * Copyright 2004 The Concord Consortium 
*/
package org.concord.otrunk.datamodel;

import java.net.URI;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashMap;

import org.concord.framework.otrunk.OTID;
import org.concord.framework.otrunk.OTPackage;


/**
 * OTDatabase
 * Class name and description
 *
 * Date created: Nov 8, 2004
 *
 * @author scott<p>
 *
 */
public interface OTDatabase
{
	public OTID getDatabaseId();
	
	public void setRoot(OTID rootId) 
		throws Exception;
	
	public OTDataObject getRoot() 
		throws Exception;	
	
	/**
	 * Make a brand new data object and create an id for it
	 * @return
	 * @throws Exception
	 */
	public OTDataObject createDataObject(OTDataObjectType type) 
		throws Exception;
	
	/**
	 * Make a brand new data object and use an existing id
	 * this is required so objects can be imported into this database
	 * @return
	 * @throws Exception
	 */
	public OTDataObject createDataObject(OTDataObjectType type, OTID id) 
		throws Exception;

	/**
	 * The dataParent must be set so the database can correctly look up the 
	 * child object.
	 * 
	 * This should only be used if you want the lowlevel view of the data
	 * it will not handle users correctly.  You must use the OTrunkImpl version
	 * of this method for that.
	 *  
	 * @param dataParent
	 * @param childID
	 * @return
	 * @throws Exception
	 */
	public OTDataObject getOTDataObject(OTDataObject dataParent, OTID childID)
		throws Exception;
	
	/**
	 * Return true if this database contains this object.  This is different
	 * than getOTDataObject because a database might be masking or replacing
	 * some objects with that method.  This method should not do that.
	 * 
	 * @param id
	 * @return
	 */
	public boolean contains(OTID id);
	
	public void close();

	public BlobResource createBlobResource(URL url);
	
	public ArrayList<Class<? extends OTPackage>> getPackageClasses();
	
	/**
	 * This is a second more human readable identifier for the database
	 * @return
	 */
	public URI getURI();
	
	public HashMap<OTID, ? extends OTDataObject> getDataObjects();
	
	/**
	 * A list of paths for all objects which refer to the passed in object, directly or indirectly.
	 * The size of the path ArrayList is the number of references that need to be traversed in order to get from one object to the other.
	 * @param otid
	 * @return
	 */
	public ArrayList<OTDataPropertyReference> getIncomingReferences(OTID otid);
	
	/**
	 * A list of paths for all objects which are referred to by the passed in object, directly or indirectly.
	 * The size of the path ArrayList is the number of references that need to be traversed in order to get from one object to the other.
	 * @param otid
	 * @return
	 */
	public ArrayList<OTDataPropertyReference> getOutgoingReferences(OTID otid);

	public void recordReference(OTID parentID, OTID childID, String property);
	public void recordReference(OTDataObject parent, OTDataObject child, String property);

	public void removeReference(OTDataObject parent, OTDataObject child);
	public void removeReference(OTID parentID, OTID childID);
	
	
}