DataFactory

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

edu.uky.rch.ept.data
Class DataFactory

java.lang.Object
  edu.uky.rch.ept.data.DataFactory

All Implemented Interfaces:: ICollectionAccessMethods, IConcurrentXMLAccessMethods, IDataAccessMethods, IDTDAccessMethods, IGenericResourceAccessMethods, IImageAccessMethods, ITextAccessMethods, IXMLAccessMethods

public class DataFactory
extends Object
implements IDataAccessMethods

This class defines a factory API that enables applications to obtain a DataFactory capable of reading from & writing to datasources. It also provides methods to get a reference to an instance of the corresponding datasource driver given an address.

Author:: Sandeep Bodapati

Field Summary

Fields inherited from interface edu.uky.rch.ept.data.IDataAccessMethods

EOF, RT_DOCUMENT, RT_NODELIST, RT_STRINGS

Method Summary
`void`	`addResourceChangeListener(String resourceAddress, IResourceChangeListener listener)` Associates the given listener with the specified address and notifies it of any changes to that resource.
`boolean`	`canRead(String address)` Check if the resource specified by the address can be read.
`boolean`	`canWrite(String address)` Check if the resource specified by the address can be written to.
`boolean`	`createCollection(String address)` Creates a collection specified by the address.
`boolean`	`deleteCollection(String address, boolean force)` Deletes the collection specified by the address.
`boolean`	`deleteCXML(String address, String dtdID, String xpath)` Removes the node at the specified location in the resource.
`boolean`	`deleteResource(String address)` Delete a resource if it exists.
`boolean`	`deleteXML(String address, String xpath)` Deletes the node pointed to by the xpath, from the xml resource.
`IAddressSelector`	`getAddressSelector(String protocolIdentifier)` Create and return a new address selector for the given protocol.
`ResourceList`	`getCollectionContents(String collectionAddress)` Returns a ResourceList containing resource descriptors for each of the resources and collections in the specified collection.
`String`	`getCXML(String address, String[] dtdIDs)` Combine the specified hierarchies of the CXML content and return the result as a pseudo-XML string.
`IDataSourceDriver`	`getDriverForProtocolIdentifier(String protocolIdentifier)` Returns a reference to the datasource driver associated with the given protocol identifier string.
`IDataSourceDriver`	`getDriverFromAddress(String address)` Returns a reference to the datasource driver referred to by the address.
`String`	`getDTD(String ID)` Retrieves the specified DTD
`org.eclipse.swt.graphics.ImageData`	`getImage(String address)` Retrieves the Image from the specified address
`BufferedInputStream`	`getInputStream(String address)` Create and return a BufferedInputStream for the resource.
`static DataFactory`	`getInstance()` Returns the shared instance of the DataFactory.
`BufferedOutputStream`	`getOutputStream(String address)` Create and return a BufferedOutputStream for the resource.
`BufferedOutputStream`	`getOutputStream(String address, boolean append)` Create and return a (possibly append-only) BufferedOutputStream for the resource.
`String`	`getProtocolFromAddress(String address)` Returns the protocol string from the address if it is a recognized protocol.
`String[]`	`getRegisteredProtocolIdentifiers()` Returns a list of valid protocol identifier strings
`String`	`getText(String address, int beginIndex, int endIndex)` Retrieves the specified text data from the resource at the given address.
`String`	`getWizardPageForProtocol(String protocolIdentifier)` Returns the name of the class which extends `NewRepositoryWizardPage`
`String`	`getXML(String address)` Retrieves the XML data from the specified address.
`org.dom4j.Document`	`getXMLDocument(String address)` Retrieves the XML data from the specified address.
`void`	`insertCXML(String address, String dtdID, String xpath, org.dom4j.Node newContent)` Inserts the given XML node into the CXML resource at the indicated location.
`void`	`insertText(String address, int atIndex, String newContent)` Inserts the new text content into the resource starting at the index specified.
`void`	`insertXML(String address, String xpath, org.dom4j.Node newContent)` Inserts the given xml node into the xml resource immediately after the node specified by the xpath.
`boolean`	`isAbsoluteAddress(String address)` Checks if the given address is an absolute address.
`boolean`	`isCollection(String address)` Returns true if the specified address points to a collection.
`Object`	`queryCXML(String xmlResourceAddress, String[] dtdID, String query, short returnType)` Executes the given query on the CXML resource and returns the results as a list of `org.dom4j.Node`s.
`Object`	`queryXML(String xmlResourceAddress, String query, short returnType)` Executes the given query on the XML resource and returns the results in the format specified by the returnType parameter.
`void`	`removeResourceChangeListener(String resourceAddress, IResourceChangeListener listener)` Disassociates the given resource change listener from the specified address and removes it from the list of listeners.
`boolean`	`renameResource(String srcAddress, String destAddress, boolean force)` Move or rename a resource from one address to another.
`void`	`replaceCXML(String address, String dtdID, String xpath, org.dom4j.Node newContent)` Replaces the node at the specified location in the resource with a new node at the same location.
`void`	`replaceCXMLContent(String xmlResourceAddress, int beginIndex, int endIndex, String newContent)` (unimplemented) Treats a CXML resource as text resource (all tags are treated as though they did not exist) and replaces the text from beginIndex to endIndex-1 with the new text content.
`void`	`replaceText(String address, int beginIndex, int endIndex, String newContent)` Replaces the specified text with the new content.
`void`	`replaceXML(String address, String xpath, org.dom4j.Node newContent)` Replaces the specified node in the resource with the new node.
`void`	`replaceXMLContent(String xmlResourceAddress, int beginIndex, int endIndex, String newContent)` Treats an xml resource as text resource (all tags are ignored as if they didnt exist) and replaces the text from beginIndex to endIndex-1 with the new text content.
`ResourceList`	`scanCollection(String address, Pattern pattern, boolean includeCollections)` Returns a ResourceList containing resource descriptors for each of the resources (and possibly collections) located within the specified collection which match the given pattern.
`boolean`	`storeCXML(String address, String[] dtdIDs, String content, boolean force)` Creates a new CXML resource.
`boolean`	`storeDTD(String ID, String content, boolean force)` Creates a new DTD resource with the given content.
`boolean`	`storeImage(String address, URL source, boolean force)` Imports the image from the source & stores it at the given address.
`boolean`	`storeResource(String address, BufferedInputStream source, boolean force)` Create a new resource with the content from the source.
`boolean`	`storeText(String address, String content, boolean force)` Creates a new text resource and writes the given content into it.
`boolean`	`storeXML(String address, org.dom4j.Document content, boolean force)` Creates a new XML resource with the given content, reindented for readability.
`boolean`	`storeXML(String address, org.dom4j.Document content, boolean force, boolean indent)` Creates a new XML resource with the given content, possibly reindented.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static DataFactory getInstance()

Returns the shared instance of the DataFactory.

Returns:: a reference to the data factory.

getRegisteredProtocolIdentifiers

public String[] getRegisteredProtocolIdentifiers()

Returns a list of valid protocol identifier strings

Returns:: list of registered protocol identifiers

getDriverForProtocolIdentifier

public IDataSourceDriver getDriverForProtocolIdentifier(String protocolIdentifier)

Returns a reference to the datasource driver associated with the given protocol identifier string.

Parameters:: protocolIdentifier - the protocol identifier to look up. The protocol identifier is the part of a data layer address preceding the first occurrence of IDataConstants.SEP_PROTOCOL.
Returns:: a reference to the datasource driver object for the given protocol, or null if no such driver is registered.

getAddressSelector

public IAddressSelector getAddressSelector(String protocolIdentifier)

Create and return a new address selector for the given protocol.

Parameters:: protocolIdentifier - the identifier of the protocol for which a selector should be created. The protocol identifier is the part of a data layer address preceding the first occurrence of IDataConstants.SEP_PROTOCOL.
Returns:: a new address selector for the specified protocol; null if no driver is associated with that protocol, or if that driver fails to provide an address selector.

getWizardPageForProtocol

public String getWizardPageForProtocol(String protocolIdentifier)

Returns the name of the class which extends NewRepositoryWizardPage

Parameters:: protocolIdentifier -
Returns:: name of the wizard page class

getDriverFromAddress

public IDataSourceDriver getDriverFromAddress(String address)
                                       throws MalformedAddressException

Returns a reference to the datasource driver referred to by the address.

Parameters:: address - the address
Returns:: a reference to the datasource driver object
Throws:: MalformedAddressException

getProtocolFromAddress

public String getProtocolFromAddress(String address)
                              throws MalformedAddressException

Returns the protocol string from the address if it is a recognized protocol.

Parameters:: address - the address
Returns:: the protocol string
Throws:: MalformedAddressException

isAbsoluteAddress

public boolean isAbsoluteAddress(String address)
                          throws NullAddressException

Checks if the given address is an absolute address. An address is considered as absoulte if it contains IDataConstants.SEP_PROTOCOL

Parameters:: address -
Returns:: true if the address is absolute, false otherwise.
Throws:: NullAddressException

addResourceChangeListener

public void addResourceChangeListener(String resourceAddress,
                                      IResourceChangeListener listener)

Associates the given listener with the specified address and notifies it of any changes to that resource. Has no effect if an identical listener is already registered.

Parameters:: resourceAddress - address of the resource; listener - the listener

removeResourceChangeListener

public void removeResourceChangeListener(String resourceAddress,
                                         IResourceChangeListener listener)

Disassociates the given resource change listener from the specified address and removes it from the list of listeners. Has no affect if an identical listener is not registered.

Parameters:: resourceAddress - address of the resource; listener - the listener

canRead

public boolean canRead(String address)
                throws MalformedAddressException,
                       IOException

Description copied from interface: IGenericResourceAccessMethods

Check if the resource specified by the address can be read.

Specified by:: canRead in interface IGenericResourceAccessMethods

Parameters:: address - address of the resource
Returns:: true if the resource exists and can be read, false otherwise.
Throws:: MalformedAddressException; IOException

canWrite

public boolean canWrite(String address)
                 throws MalformedAddressException,
                        IOException

Description copied from interface: IGenericResourceAccessMethods

Check if the resource specified by the address can be written to.

Specified by:: canWrite in interface IGenericResourceAccessMethods

Returns:: true if the resource can be created if it doesnt already exist or written to if it exists; false otherwise.
Throws:: MalformedAddressException; IOException

isCollection

public boolean isCollection(String address)
                     throws MalformedAddressException,
                            IOException

Description copied from interface: ICollectionAccessMethods

Returns true if the specified address points to a collection.

Specified by:: isCollection in interface ICollectionAccessMethods

Parameters:: address - the address to check
Returns:: true if the address points to an existing collection
Throws:: MalformedAddressException; IOException

createCollection

public boolean createCollection(String address)
                         throws MalformedAddressException,
                                IOException

Description copied from interface: ICollectionAccessMethods

Creates a collection specified by the address.

Specified by:: createCollection in interface ICollectionAccessMethods

Parameters:: address - address of the collection
Returns:: true if the collection did not exist and was succesfully created, false otherwise.
Throws:: MalformedAddressException; IOException

deleteCollection

public boolean deleteCollection(String address,
                                boolean force)
                         throws MalformedAddressException,
                                IOException

Description copied from interface: ICollectionAccessMethods

Deletes the collection specified by the address.

Specified by:: deleteCollection in interface ICollectionAccessMethods

Parameters:: address - address of the collection; force - if true, then the collection will be deleted even if it contains resources and other sub-collections. Use with caution, as all resources contained within the collection will be deleted
Returns:: true if the collection existed and was succesfully deleted, false otherwise.
Throws:: MalformedAddressException; IOException

deleteResource

public boolean deleteResource(String address)
                       throws MalformedAddressException,
                              IOException

Description copied from interface: IGenericResourceAccessMethods

Delete a resource if it exists.

Specified by:: deleteResource in interface IGenericResourceAccessMethods

Parameters:: address - address of the resource
Returns:: true if the resource existed and was succesfully deleted, false otherwise
Throws:: MalformedAddressException; IOException

getText

public String getText(String address,
                      int beginIndex,
                      int endIndex)
               throws MalformedAddressException,
                      ResourceNotFoundException,
                      IndexOutOfBoundsException,
                      IOException

Description copied from interface: ITextAccessMethods

Retrieves the specified text data from the resource at the given address. The text data is read starting from the beginIndex to the character at index endIndex-1. Thus the length of the substring returned is endIndex-beginIndex. If endIndex is EOF, then the contents will be read till the end of the resource.

Specified by:: getText in interface ITextAccessMethods

Parameters:: address - address of the resource; beginIndex - the beginning index, inclusive.; endIndex - the endIndex, exclusive.
Returns:: the specified text data from the resource
Throws:: IndexOutOfBoundsException - if the beginIndex is negative, or beginIndex is larger than endIndex and endIndex is not EOF.; ResourceNotFoundException - if the resource doesnt exist; MalformedAddressException; IOException

storeText

public boolean storeText(String address,
                         String content,
                         boolean force)
                  throws MalformedAddressException,
                         IOException

Description copied from interface: ITextAccessMethods

Creates a new text resource and writes the given content into it.

Specified by:: storeText in interface ITextAccessMethods

Parameters:: address - the address of the resource; content - the data to be written; force - if true then the resource is overwritten if it already exists
Returns:: true if the resource did not exist and was created successfully, false otherwise
Throws:: MalformedAddressException; IOException

insertText

public void insertText(String address,
                       int atIndex,
                       String newContent)
                throws MalformedAddressException,
                       ResourceNotFoundException,
                       IndexOutOfBoundsException,
                       IOException

Description copied from interface: ITextAccessMethods

Inserts the new text content into the resource starting at the index specified. If atIndex is greater than the length of the resource or is EOF, the new text will be appended to the resource

Specified by:: insertText in interface ITextAccessMethods

Parameters:: address - the address of the resource; atIndex - offset from the beginning of the resource; newContent - text to be inserted
Throws:: ResourceNotFoundException - if the resource doesnt exist; IndexOutOfBoundsException - if the atIndex is negative and not EOF; MalformedAddressException; IOException

replaceText

public void replaceText(String address,
                        int beginIndex,
                        int endIndex,
                        String newContent)
                 throws MalformedAddressException,
                        ResourceNotFoundException,
                        IndexOutOfBoundsException,
                        IOException

Description copied from interface: ITextAccessMethods

Replaces the specified text with the new content. The text that is replaced starts from beginIndex and ends at endIndex-1. If endIndex is EOF, then the text till the end of the resource will be replaced.

Specified by:: replaceText in interface ITextAccessMethods

Parameters:: address - address of the resource; beginIndex - beginning index, inclusive; endIndex - end index, exclusive; newContent - new content to replace the text
Throws:: IndexOutOfBoundsException - if the beginIndex is negative, or beginIndex is larger than endIndex and endIndex is not EOF.; ResourceNotFoundException - if the resource doesnt exist; MalformedAddressException; IOException