package com.dbxml.db.common.adapters;
/*
* dbXML - Native XML Database
* Copyright (c) 1999-2006 The dbXML Group, L.L.C.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* $Id: DOMAdapter.java,v 1.5 2006/02/02 18:53:47 bradford Exp $
*/
import com.dbxml.db.core.Collection;
import com.dbxml.db.core.DBException;
import com.dbxml.db.core.FaultCodes;
import com.dbxml.db.core.adapter.SimpleAdapter;
import com.dbxml.db.core.data.Key;
import com.dbxml.db.core.transaction.Transaction;
import com.dbxml.xml.dtsm.DTSMException;
import com.dbxml.xml.dtsm.DTSMHelper;
import com.dbxml.xml.dtsm.DocumentTable;
import org.w3c.dom.Document;
/**
* DOMAdapter adapts a dbXML Collection to support the management of
* DOM Documents.
*/
public final class DOMAdapter extends SimpleAdapter {
public DOMAdapter(Collection col) {
super(col);
}
private void putDocument(Transaction tx, Object key, Document doc) throws DBException {
try {
DocumentTable dt = DTSMHelper.nodeToTable(doc, col.getSymbols());
col.setDocument(tx, key, dt);
}
catch ( DTSMException e ) {
throw new DBException(FaultCodes.COL_CANNOT_STORE, "Error storing object '" + key + "'", e);
}
}
/**
* setDocument sets a DOM Document in the Collection based on the provided
* Key.
*
* @param tx The controlling Transaction
* @param key The Key to use
* @param obj The Document to set
* @throws DBException If a Database Exception occurs
*/
public void setDocument(Transaction tx, Object key, Document doc) throws DBException {
putDocument(tx, key, doc);
}
/**
* insertDocument inserts a DOM Document into the Collection and returns a
* newly generated Key.
*
* @param tx The controlling Transaction
* @param obj The Document to insert
* @return The new Object Identifier
* @throws DBException If a Database Exception occurs
*/
public Key insertDocument(Transaction tx, Document doc) throws DBException {
Key key = col.createNewOID();
putDocument(tx, key, doc);
return key;
}
/**
* insertDocument inserts a DOM Document into the Collection based
* on the specified Key.
*
* @param tx The controlling Transaction
* @param key The Key to use
* @param obj The Document to insert
* @throws DBException If a Database Exception occurs
*/
public void insertDocument(Transaction tx, Object key, Document doc) throws DBException {
putDocument(tx, key, doc);
}
/**
* getDocument instantiates and returns a DOM Document based on the
* provided Key.
*
* @param tx The controlling Transaction
* @param key The Document Key
* @return a DOM Document
* @throws DBException If a Database Exception occurs
*/
public Document getDocument(Transaction tx, Object key) throws DBException {
try {
DocumentTable dt = col.getDocument(tx, key);
if ( dt != null )
return DTSMHelper.tableToDocument(dt);
else
return null;
}
catch ( DTSMException e ) {
throw new DBException(FaultCodes.COL_CANNOT_RETRIEVE, "Error retrieving object '" + key + "'", e);
}
}
}