Skip to Content.
Sympa Menu

notify-dpml - svn commit: r3000 - development/main/transit/core/handler/src/main/net/dpml/transit/store

notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

Chronological Thread  
  • From: mcconnell AT dpml.net
  • To: notify-dpml AT lists.ibiblio.org
  • Subject: svn commit: r3000 - development/main/transit/core/handler/src/main/net/dpml/transit/store
  • Date: Thu, 07 Jul 2005 00:07:13 -0400

Author: mcconnell AT dpml.net
Date: Thu Jul 7 00:07:13 2005
New Revision: 3000

Modified:

development/main/transit/core/handler/src/main/net/dpml/transit/store/CacheStorage.java

development/main/transit/core/handler/src/main/net/dpml/transit/store/CodeBaseStorage.java

development/main/transit/core/handler/src/main/net/dpml/transit/store/Removable.java

development/main/transit/core/handler/src/main/net/dpml/transit/store/TransitHome.java

development/main/transit/core/handler/src/main/net/dpml/transit/store/package.html
Log:
more javadoc

Modified:
development/main/transit/core/handler/src/main/net/dpml/transit/store/CacheStorage.java
==============================================================================
---
development/main/transit/core/handler/src/main/net/dpml/transit/store/CacheStorage.java
(original)
+++
development/main/transit/core/handler/src/main/net/dpml/transit/store/CacheStorage.java
Thu Jul 7 00:07:13 2005
@@ -28,14 +28,29 @@
public interface CacheStorage extends CodeBaseStorage
{
/**
- * Return the cache directory path.
+ * Return the cache directory path assigned to the cache storage unit.
* @return the cache directory path
*/
String getCacheDirectoryPath();

+ /**
+ * Set the cache directory path to the supplied value. The value may
contain
+ * symbolic values in the form <code>${variable}</code> where varaible is
the
+ * name of an existing system property.
+ *
+ * @param path a symbolic path
+ */
void setCacheDirectoryPath( String path );

+ /**
+ * Return the layout model key assiciated with the cache storage unit.
+ * @return the cache storage layout key
+ */
String getLayoutModelKey();

+ /**
+ * Set the layout for the cache.
+ * @param key the layout key identifier
+ */
void setLayoutModelKey( String key );
}

Modified:
development/main/transit/core/handler/src/main/net/dpml/transit/store/CodeBaseStorage.java
==============================================================================
---
development/main/transit/core/handler/src/main/net/dpml/transit/store/CodeBaseStorage.java
(original)
+++
development/main/transit/core/handler/src/main/net/dpml/transit/store/CodeBaseStorage.java
Thu Jul 7 00:07:13 2005
@@ -27,7 +27,18 @@
*/
public interface CodeBaseStorage
{
+ /**
+ * Return the URI identifying a codebase. Tpically this value returned
from
+ * this operation identifes a plugin uses as a system extension or
customization
+ * point.
+ *
+ * @return the codebase uri
+ */
URI getCodeBaseURI();

+ /**
+ * Set the codebase uri.
+ * @param the uri identifying the codebase for a system extension
+ */
void setCodeBaseURI( URI uri );
}

Modified:
development/main/transit/core/handler/src/main/net/dpml/transit/store/Removable.java
==============================================================================
---
development/main/transit/core/handler/src/main/net/dpml/transit/store/Removable.java
(original)
+++
development/main/transit/core/handler/src/main/net/dpml/transit/store/Removable.java
Thu Jul 7 00:07:13 2005
@@ -25,5 +25,8 @@
*/
public interface Removable
{
+ /**
+ * Remove the storage unit.
+ */
void remove();
}

Modified:
development/main/transit/core/handler/src/main/net/dpml/transit/store/TransitHome.java
==============================================================================
---
development/main/transit/core/handler/src/main/net/dpml/transit/store/TransitHome.java
(original)
+++
development/main/transit/core/handler/src/main/net/dpml/transit/store/TransitHome.java
Thu Jul 7 00:07:13 2005
@@ -19,15 +19,32 @@
package net.dpml.transit.store;

/**
- * The Home defines the persistent storage home for transit management
configurations.
+ * The Home defines the persistent storage home for a collection of
persistent transit
+ * configurations.
*
* @author <a href="http://www.dpml.net";>The Digital Product Meta Library</a>
*/
public interface TransitHome
{
+ /**
+ * Return the inital collection of transit storage unit instances.
+ * @return the array of transit starage instances
+ */
TransitStorage[] getInitialTransitStores();

+ /**
+ * Return a Transit storage profile relative to the supplied identifier.
If
+ * the storage identifier is not recognized, an implementation will
construct
+ * a new profile using the supplied identifier.
+ *
+ * @param id the tranist configuration profile identifier
+ * @return the corresponding stoarage unit
+ */
TransitStorage getTransitStorage( String id );

+ /**
+ * Return the set of storage profiles managed by the home implementing
this interface.
+ * @return the set of available transit profile names
+ */
String[] getProfileNames();
}

Modified:
development/main/transit/core/handler/src/main/net/dpml/transit/store/package.html
==============================================================================
---
development/main/transit/core/handler/src/main/net/dpml/transit/store/package.html
(original)
+++
development/main/transit/core/handler/src/main/net/dpml/transit/store/package.html
Thu Jul 7 00:07:13 2005
@@ -1,7 +1,7 @@

<body>
<p>
-The management package defines a set of interfaces dealing with model
updating and change management.
+The <code>net.dpml.transit.store</code> package defines a set of interfaces
dealing with content storage system contacts. The pricipal <a
href="TransitStorage.html">TransitStorage</a> interface defines the contract
for object implementing the persistent storage of a Transit configuration
profile. Multiple profiles are maintains under implementations of the <a
href="TransitHome.html">TransitHome</a> interface.
</p>.
</body>




  • svn commit: r3000 - development/main/transit/core/handler/src/main/net/dpml/transit/store, mcconnell, 07/07/2005

Archive powered by MHonArc 2.6.24.

Top of Page