org.ocd.docservice
Interface IXMLDocumentService

All Known Implementing Classes:

XMLDocumentService

public interface IXMLDocumentService

Since:

$Date: 2002/06/12 03:58:04 $

Version:

$Revision: 1.5 $

Author:

$Author: drichan $, ocd_dino - ocd_dino@users.sourceforge.net (initial author)

Field Summary

static char	PATH_SEPERATOR
static java.lang.String	PROTOCOL

Method Summary

org.w3c.dom.Document	getDocument(java.lang.String pPath) Gets a Document
java.net.URLStreamHandler	getHandler() Get the URLStreamHandler for the DocSerice
java.io.InputStream	getInputStream(java.lang.String pPath) Gets an InputStream to a document
java.lang.String[]	listDocuments(java.lang.String pPath) List Documents in an Path
java.lang.String[]	listSubDirectories(java.lang.String pPath) List Sub Directories in a Path
void	removeDocument(java.lang.String pPath) Removes a Document
void	storeDocument(java.lang.String pPath, org.w3c.dom.Document pDocument) Stores a Document

Field Detail

PROTOCOL

public static final java.lang.String PROTOCOL

PATH_SEPERATOR

public static final char PATH_SEPERATOR

Method Detail

getInputStream

public java.io.InputStream getInputStream(java.lang.String pPath)
                                   throws java.io.IOException

Gets an InputStream to a document

Parameters:

pPath - file name of document you want an inputstream to

Returns:

InputStream

getDocument

public org.w3c.dom.Document getDocument(java.lang.String pPath)
                                 throws XMLDocumentNotFound,
                                        java.io.IOException

Gets a Document

Parameters:

pPath - file name of document you want to get

Returns:

DOM Document

storeDocument

public void storeDocument(java.lang.String pPath,
                          org.w3c.dom.Document pDocument)
                   throws java.io.IOException

Stores a Document

Parameters:

pPath - file name of document you want to store

pDocument - DOM Document object for the Document

removeDocument

public void removeDocument(java.lang.String pPath)
                    throws java.io.IOException

Removes a Document

Parameters:

pPath - file name of document you want to store

listDocuments

public java.lang.String[] listDocuments(java.lang.String pPath)
                                 throws java.io.IOException

List Documents in an Path

Parameters:

pPath - parent path you want to retrieve document names from

Returns:

Array of Strings

listSubDirectories

public java.lang.String[] listSubDirectories(java.lang.String pPath)
                                      throws java.io.IOException

List Sub Directories in a Path

Parameters:

pPath - parent path you want to retrieve sub dirs names from

Returns:

Array of Strings

getHandler

public java.net.URLStreamHandler getHandler()

Get the URLStreamHandler for the DocSerice

Returns:

handler for this Service