001: /*
002: * hgcommons 7
003: * Hammurapi Group Common Library
004: * Copyright (C) 2003 Hammurapi Group
005: *
006: * This program is free software; you can redistribute it and/or
007: * modify it under the terms of the GNU Lesser General Public
008: * License as published by the Free Software Foundation; either
009: * version 2 of the License, or (at your option) any later version.
010: *
011: * This program is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * Lesser General Public License for more details.
015: *
016: * You should have received a copy of the GNU Lesser General Public
017: * License along with this library; if not, write to the Free Software
018: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
019: *
020: * URL: http://www.hammurapi.biz/hammurapi-biz/ef/xmenu/hammurapi-group/products/products/hgcommons/index.html
021: * e-Mail: support@hammurapi.biz
022: */
023: package biz.hammurapi.sql;
024:
025: import java.sql.SQLException;
026: import java.util.Properties;
027:
028: import org.w3c.dom.Element;
029:
030: import biz.hammurapi.config.ConfigurationException;
031:
032: /**
033: * Interface of DatabaseObject. This interface is used for creating dynamic proxies backed
034: * up with database obects.
035: * @author Pavel Vlasov
036: * @revision $Revision$
037: */
038: public interface IDatabaseObject {
039:
040: /**
041: * Updates row in a table by primary key
042: * @param processor SQLProcessor
043: * @param tableName Target table
044: * @return Number of updates
045: * @throws SQLException
046: */
047: public abstract int update(SQLProcessor processor, String tableName)
048: throws SQLException;
049:
050: /**
051: * Deletes row in a table by primary key.
052: * @param processor SQLProcessor
053: * @param tableName Target table
054: * @return Number of updates
055: * @throws SQLException
056: */
057: public abstract int delete(SQLProcessor processor, String tableName)
058: throws SQLException;
059:
060: public abstract int insert(SQLProcessor processor, String tableName)
061: throws SQLException;
062:
063: /**
064: * Loads columns from XML element
065: * @param holder
066: * @throws ConfigurationException If loading fails
067: */
068: public abstract void fromDom(Element holder)
069: throws ConfigurationException;
070:
071: public abstract void fromDom(Element holder, Properties nameMap)
072: throws ConfigurationException;
073:
074: /**
075: * Serializes to DOM.
076: * @param holder Holder element
077: * @param nameMap Name map
078: * @param originals Output original values if any.
079: */
080: public abstract void toDom(Element holder, Properties nameMap,
081: boolean originals);
082:
083: /**
084: * Sets current values as original values in primary key columns.
085: */
086: public abstract void setOriginal();
087:
088: /**
089: * @return true if object was modified since last database operation.
090: */
091: public abstract boolean isModified();
092:
093: /**
094: * isDeleted flag is cleared when primary key columns are modified
095: * @return true if delete() method was executed.
096: */
097: public abstract boolean isDeleted();
098:
099: /**
100: * Sets all columns to default values and clears
101: * modified and deleted flags.
102: *
103: */
104: public abstract void clear();
105:
106: /**
107: * Copies values from source object to this object
108: * @param source
109: */
110: public abstract void copy(DatabaseObject source);
111:
112: public abstract void setColumnAttribute(String columnName,
113: Object key, Object value);
114:
115: public abstract Object getColumnAttribute(String columnName,
116: Object key);
117:
118: public abstract Object removeColumnAttribute(String columnName,
119: Object key);
120:
121: }
|