Repository

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.projectexplorer.model
Class Repository

java.lang.Object
  edu.uky.rch.ept.projectexplorer.model.Repository

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

public class Repository
extends Object
implements IDataAccessMethods

Repository is a persistent data store that coordinates multi-user access to projects and their contents. Repositories could be either local or remote. Every Repository has a location(root). A repository location is not an actual live connection. Instead, it is a description of where the repository is located. The Workbench will create a connection based on this location information. Connections will be opened and closed as required when performing data access operations.

Author:: sandeep

Field Summary
`static String`	`ATT_ID` Every Project is associated with a unique ID.
`static String`	`TAG_PROJECT` The tag used to identify an entry for a Project.
`static String`	`TAG_PROJECTS` The head tag used in the Projects list configuration file.

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

EOF, RT_DOCUMENT, RT_NODELIST, RT_STRINGS

Constructor Summary
`Repository(String root, String description)` Creates a new Repository with the given root and description.

Method Summary
`boolean`	`addProject(Project project)` Adds the given project to this repository if it isnt already contained in this repository.
`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.
`protected boolean`	`copyCollectionContents(String sourceCollectionAddress, String destinationCollectionAddress)` Copies all resources from the source collection (should be accessed using the DataFactory) to the destination collection.
`boolean`	`copyProject(Project project)` Copies the given project into this repository.
`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`	`deleteProject(Project project)` Deletes the given project and its contents from this repository.
`boolean`	`deleteProject(Project project, boolean deleteResources)` Deletes the given project from this repository, optionally deleting the project's contents as well.
`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.
`boolean`	`equals(Object object)`
`String`	`getAbsoluteAddress(String address)` Returns the absolute address for the given address.
`String[]`	`getAbsoluteIDs(String[] IDs)` Returns the absoulte IDs for the given DTD IDs.
`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.
`String`	`getDescription()` Return the description of the repository.
`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.
`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.
`Project`	`getProject(String ID)` Returns a reference to the project with the given ID.
`Project[]`	`getProjects()` Returns an array of projects contained in this repository.
`String`	`getRoot()` Returns the root/location of the repository.
`String`	`getText(String address, int beginIndex, int endIndex)` Retrieves the specified text data from the resource at the given address.
`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.
`boolean`	`hasProjects()` Returns true (lazy approach)
`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 absolute or relative.
`boolean`	`isCollection(String address)` Returns true if the specified address points to a collection.
`boolean`	`moveProject(Project project, Repository destinationRepository)` Moves the specified project from this repository to the destination repository.
`Object`	`queryCXML(String xmlResourceAddress, String[] dtdIDs, 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.
`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.
`void`	`setDescription(String description)` Updates the description of the repository.
`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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG_PROJECTS

public static String TAG_PROJECTS

The head tag used in the Projects list configuration file.

TAG_PROJECT

public static String TAG_PROJECT

The tag used to identify an entry for a Project.

ATT_ID

public static String ATT_ID

Every Project is associated with a unique ID.

Constructor Detail

Repository

public Repository(String root,
                  String description)

Creates a new Repository with the given root and description.
Parameters:: root - location of the repository; description - description of the repository

Method Detail

getDescription

public String getDescription()

Return the description of the repository.

Returns:: description

getRoot

public String getRoot()

Returns the root/location of the repository.

Returns:: root

setDescription

public void setDescription(String description)
                    throws MalformedAddressException,
                           ResourceNotFoundException,
                           IOException

Updates the description of the repository.

Parameters:: description - new description
Throws:: MalformedAddressException; ResourceNotFoundException; IOException

getProjects

public Project[] getProjects()

Returns an array of projects contained in this repository.

Returns:: array of projects

hasProjects

public boolean hasProjects()

Returns true (lazy approach)

Returns:: true

addProject

public boolean addProject(Project project)

Adds the given project to this repository if it isnt already contained in this repository.

Parameters:: project - the project to add
Returns:: true if the project wasnt already a child of this repository and was successfully added; false otherwise

getProject

public Project getProject(String ID)

Returns a reference to the project with the given ID.

Parameters:: ID - the ID to search for
Returns:: reference to the Project if the ID was found; null otherwise

deleteProject

public boolean deleteProject(Project project)

Deletes the given project and its contents from this repository.

Parameters:: project - the project to delete
Returns:: true if the project exists and belongs to this repository and was successfully deleted.

deleteProject

public boolean deleteProject(Project project,
                             boolean deleteResources)

Deletes the given project from this repository, optionally deleting the project's contents as well.

Parameters:: project - the project to delete; deleteResources - if true, also delete the resources belonging to the project.
Returns:: true if the project existed, belonged to this repository, and was successfully deleted.

isAbsoluteAddress

public boolean isAbsoluteAddress(String address)

Checks if the given address is absolute or relative.

Parameters:: address - the address to check
Returns:: true if the address is absolute, false otherwise

getAbsoluteAddress

public String getAbsoluteAddress(String address)

Returns the absolute address for the given address. The address is returned as is if it is already an absolute address.

Parameters:: address - the address
Returns:: absolute address

getAbsoluteIDs

public String[] getAbsoluteIDs(String[] IDs)

Returns the absoulte IDs for the given DTD IDs.

Parameters:: IDs - the IDs
Returns:: array of absolute IDs

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