001: /*
002: * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
003: *
004: * This file is part of Resin(R) Open Source
005: *
006: * Each copy or derived work must preserve the copyright notice and this
007: * notice unmodified.
008: *
009: * Resin Open Source is free software; you can redistribute it and/or modify
010: * it under the terms of the GNU General Public License as published by
011: * the Free Software Foundation; either version 2 of the License, or
012: * (at your option) any later version.
013: *
014: * Resin Open Source is distributed in the hope that it will be useful,
015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
017: * of NON-INFRINGEMENT. See the GNU General Public License for more
018: * details.
019: *
020: * You should have received a copy of the GNU General Public License
021: * along with Resin Open Source; if not, write to the
022: * Free Software Foundation, Inc.
023: * 59 Temple Place, Suite 330
024: * Boston, MA 02111-1307 USA
025: *
026: * @author Scott Ferguson
027: */
028:
029: package com.caucho.amber;
030:
031: import java.sql.ResultSet;
032: import java.sql.SQLException;
033: import java.util.List;
034:
035: /**
036: * Main user interface to Amber.
037: */
038: public interface AmberConnection {
039: /**
040: * Loads the entity specified by its class and primary key.
041: */
042: public Object load(Class cl, Object key) throws AmberException;
043:
044: /**
045: * Loads the entity specified by its class and primary key.
046: */
047: public Object load(Class cl, long key) throws AmberException;
048:
049: /**
050: * Loads the entity, returning the active entity
051: */
052: public Object makePersistent(Object entity) throws SQLException;
053:
054: /**
055: * Creates a new entity given the values in the object.
056: */
057: public void create(Object obj) throws SQLException;
058:
059: /**
060: * Returns true if the entitiy is managed.
061: */
062: public boolean contains(Object entity);
063:
064: /**
065: * Deletes the specified entry.
066: */
067: public void delete(Object obj) throws SQLException;
068:
069: /**
070: * Queries the database, returning a result set
071: *
072: * @param query the query
073: *
074: * @return the query result set.
075: */
076: public ResultSet query(String query) throws SQLException;
077:
078: /**
079: * Queries the database, returning a result set
080: *
081: * @param query the query
082: *
083: * @return the query result set.
084: */
085: public int update(String query) throws SQLException;
086:
087: /**
088: * Creates a query object from a query string.
089: *
090: * The query will load the default group values for any selected
091: * entitites.
092: *
093: * @param query a query
094: */
095: public AmberQuery prepareQuery(String queryString)
096: throws AmberException;
097:
098: /**
099: * Starts a transaction.
100: */
101: public void beginTransaction() throws SQLException;
102:
103: /**
104: * Commits a transaction.
105: */
106: public void commit() throws SQLException;
107:
108: /**
109: * Rolls a transaction back.
110: */
111: public void rollback() throws SQLException;
112:
113: /**
114: * Flushes data from the connection.
115: */
116: public void flush() throws SQLException;
117:
118: /**
119: * Closes the connection. Unlike JDBC, this will never throw an
120: * exception (although it may log a warning.)
121: */
122: public void close();
123:
124: /**
125: * Queries the database, returning a result set
126: *
127: * @param query the query
128: *
129: * @return the query result set.
130: */
131: public List find(String query) throws SQLException;
132: }
|