Project

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 Project

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

All Implemented Interfaces:: ICollectionAccessMethods, IConcurrentXMLAccessMethods, IDataAccessMethods, IDTDAccessMethods, IGenericResourceAccessMethods, IImageAccessMethods, org.eclipse.ui.views.properties.IPropertySource, ITextAccessMethods, IXMLAccessMethods

public class Project
extends Object
implements IDataAccessMethods, org.eclipse.ui.views.properties.IPropertySource

A Project is a grouping of related resources and collections. Every project belongs to a Repository but not every resource of a project needs to belong to the same repository.

Author:: sandeep

Field Summary
`static String`	`ATT_NAME`
`static String`	`TAG_PROJECT`

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

EOF, RT_DOCUMENT, RT_NODELIST, RT_STRINGS

Constructor Summary
`Project(String ID, Repository repository)` Creates a new Project with the given ID and repository.
`Project(String name, String path, Repository repository)` Creates a new Project with the given name, path, and repository.

Method Summary
`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`	`copyCollectionContents(String sourceCollectionAddress, String destinationCollectionAddress)` Copies all resources from the source collection (should be accessed using the DataFactory) to the destination collection.
`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.
`boolean`	`equals(Object object)`
`static String`	`generateID(String projectName)` Generate and returns an ID from the given projectname.
`String`	`getAbsoluteAddress(String address)` Returns the absolute address for the give address.
`Object[]`	`getChildren()` Returns the children of this project.
`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()` Returns the description of this project
`String`	`getDTD(String ID)` Retrieves the specified DTD
`Object`	`getEditableValue()`
`String`	`getID()` Returns the ID of this project
`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.
`String`	`getName()` Returns the name of this project
`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.
`org.eclipse.ui.views.properties.IPropertyDescriptor[]`	`getPropertyDescriptors()`
`Object`	`getPropertyValue(Object id)`
`protected String`	`getRelativeAddress(String address)` Returns the Repository-relative address for the given address
`protected String[]`	`getRelativeIDs(String[] IDs)`
`Repository`	`getRepository()` Returns a reference to the parent repository.
`String`	`getText(String address, int beginIndex, int endIndex)` Retrieves the specified text data from the resource at the given address.
`String`	`getTimestamp()` Returns the timestamp of this project
`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`	`hasChildren()` 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.
`boolean`	`isCollection(String address)` Returns true if the specified address points to a collection.
`boolean`	`isPropertySet(Object id)`
`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 address, 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 address, 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.
`void`	`resetPropertyValue(Object id)`
`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 for this project
`void`	`setName(String name)` Sets the name for this project
`void`	`setPropertyValue(Object id, Object value)`
`void`	`setRepository(Repository source)` Updates the parent repository for this project.
`void`	`setTimestamp(String timestamp)` Sets the timestamp for this project
`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_PROJECT

public static String TAG_PROJECT

ATT_NAME

public static String ATT_NAME

Constructor Detail

Project

public Project(String name,
               String path,
               Repository repository)

Creates a new Project with the given name, path, and repository. The ID of the project is unspecified by this API, and may be obtained by the getID() method.
Parameters:: name - human-readable name of the project. If name is null, read the name from an existing project.xml,; path - path of the project, as a data layer path string. The path string may be either absolute (if it contains "://") or relative.; repository - the repository to which the project should belong

Project

public Project(String ID,
               Repository repository)

Creates a new Project with the given ID and repository. The ID is used as the name of the project; the project will be stored in a data layer path determined by the repository and ID, though the precise path created is not specified by this API. Use the three-argument constructor to create a project in a particular location.
Parameters:: ID - identifier for the project.; repository - the repository to which the project should belong

Method Detail

getChildren

public Object[] getChildren()

Returns the children of this project. The children of a project are gather from the extensions to the ProjectItemsContributor tag of the ProjectContributions extension point. These contributions can be made from any number of tools installed in the workbench.

Returns:: an array of children

hasChildren

public boolean hasChildren()

Returns true (lazy approach)

Returns:: true

getRepository

public Repository getRepository()

Returns a reference to the parent repository.

Returns:: parent repository

getDescription

public String getDescription()

Returns the description of this project

Returns:: description

getID

public String getID()

Returns the ID of this project

Returns:: ID

getName

public String getName()

Returns the name of this project

Returns:: name

getTimestamp

public String getTimestamp()

Returns the timestamp of this project

Returns:: timestamp

setRepository

public void setRepository(Repository source)

Updates the parent repository for this project.

Parameters:: source - parent repository

setDescription

public void setDescription(String description)

Updates the description for this project

Parameters:: description - new description

setName

public void setName(String name)

Sets the name for this project

Parameters:: name - new name

setTimestamp

public void setTimestamp(String timestamp)

Sets the timestamp for this project

Parameters:: timestamp - new timestamp

isAbsoluteAddress

public boolean isAbsoluteAddress(String address)

Checks if the given address is absolute.

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

getRelativeAddress

protected String getRelativeAddress(String address)

Returns the Repository-relative address for the given address

Parameters:: address - the address
Returns:: repository-relative address

getAbsoluteAddress

public String getAbsoluteAddress(String address)

Returns the absolute address for the give address. The address is returned as-is if it is already absolute.

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

getRelativeIDs

protected String[] getRelativeIDs(String[] IDs)

Parameters:: IDs -
Returns:

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