ozonedocumentfactory.java

Java的面向对象数据库系统的源代码

// You can redistribute this software and/or modify it under the terms of
// the Ozone Library License version 1 published by ozone-db.org.
//
// The original code and portions created by SMB are
// Copyright (C) 1997-@year@ by SMB GmbH. All rights reserved.
//
// $Id: OzoneDocumentFactory.java,v 1.5 2003/11/02 18:10:03 per_nyfelt Exp $
package org.ozoneDB.xml.dom4j;

import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.NodeFactory;
import org.dom4j.XPathFactory;
import org.ozoneDB.OzoneRemote;

import java.util.List;
import java.util.Map;

/**
 *
 * <br> Date: Jul 27, 2002
 * @author Per Nyfelt
 */
public interface OzoneDocumentFactory extends NodeFactory, XPathFactory, OzoneRemote {

    public static final String OBJECT_NAME = "DocumentFactory";

    /**
     *
     * @param name is the name for the document which is used to retrieve the
     * document at a later time.
     * @return
     * @throws Exception
     */
    Document createDocument(String name) throws Exception;

    /**
     *
     * @param rootElement
     * @param name is the name for the document which is used to retrieve the
     * document at a later time.
     * @return
     * @throws Exception
     */
    Document createDocument(Element rootElement, String name) throws Exception;

    /** Returns a list of all the QNameImpl instances currently used by this document factory
     *  @deprecated or was it just forgotten when the interfaces war created?
     */
    List getQNames();

    /** @return the Map of namespace URIs that will be used by by XPath expressions
     * to resolve namespace prefixes into namespace URIs. The map is keyed by
     * namespace prefix and the value is the namespace URI. This value could well be
     * null to indicate no namespace URIs are being mapped.
     */
    public Map getXPathNamespaceURIs();

}