: Interface ResourceSpace

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.w3c.tools.resources
Interface ResourceSpace

All Known Implementing Classes:
  ResourceStoreManager

public interface ResourceSpace

Method Summary
`void` | `acquireChildren(SpaceEntry sentry)` Acquire the children of the resource.
`void` | `acquireChildren(SpaceEntry sentry, java.io.File repository, boolean transientFlag)` acquire children from an external file.
`ResourceReference` | `addResource(SpaceEntry sentry, Resource resource, java.util.Hashtable defs)` Add this resource to the space.
`void` | `checkpoint()` Checkpoint all modified resource, by saving them to disk.
`void` | `deleteChildren(SpaceEntry sentry)` Delete all the children of resource indentified by its space entry.
`void` | `deleteResource(SpaceEntry sentry, Resource resource)` Delete this resource from the space.
`java.util.Enumeration` | `enumerateResourceIdentifiers(SpaceEntry sentry)` Enumerate the name (ie identifiers) of the resource children identified by its space entry.
`ResourceEventQueue` | `getEventQueue()`
`ResourceReference` | `loadResource(SpaceEntry sentry, java.lang.String identifier, java.util.Hashtable defs)` Restore the resource whose name is given.
`ResourceReference` | `loadRootResource(java.lang.String identifier, java.util.Hashtable defs)` Restore the resource whose name is given from the root.
`ResourceReference` | `lookupResource(SpaceEntry sentry, java.lang.String identifier)` Lookup this resource.
`void` | `markModified(SpaceEntry sentry, Resource resource)` Mark the given resource as being modified.
`void` | `renameResource(SpaceEntry sentry, java.lang.String oldid, java.lang.String newid)` Rename a resource in this resource space.
`void` | `saveChildren(SpaceEntry sentry)` Save all the children of the resource indentified by its spaec entry.
`void` | `saveResource(SpaceEntry sentry, Resource resource)` Save this resource to the space.
`void` | `shutdown()` Shutdown this resource space.

Method Detail

### getEventQueue

    public ResourceEventQueue getEventQueue()

### shutdown

    public void shutdown()

  Shutdown this resource space. Go through all entries, and shut them down.

### checkpoint

    public void checkpoint()

  Checkpoint all modified resource, by saving them to disk.

### loadRootResource

    public ResourceReference loadRootResource(java.lang.String identifier,
                                              java.util.Hashtable defs)

  Restore the resource whose name is given from the root.
  Parameters:
    `identifier` - The identifier of the resource to restore.
    `defs` - Default attribute values.

### lookupResource

    public ResourceReference lookupResource(SpaceEntry sentry,
                                            java.lang.String identifier)

  Lookup this resource.
  Parameters:
    `sentry` - The resource space entry.
    `identifier` - The resource identifier.
  Returns:
    A Resource instance, or null if either the resource doesn't exist, or it isn't loaded yet.

### loadResource

    public ResourceReference loadResource(SpaceEntry sentry,
                                          java.lang.String identifier,
                                          java.util.Hashtable defs)

  Restore the resource whose name is given.
  Parameters:
    `sentry` - The resource space entry.
    `identifier` - The identifier of the resource to restore.
    `defs` - Default attribute values.

### addResource

    public ResourceReference addResource(SpaceEntry sentry,
                                         Resource resource,
                                         java.util.Hashtable defs)

  Add this resource to the space.
  Parameters:
    `sentry` - The resource space entry.
    `resource` - The resource to add.
    `defs` - Default attribute values.

### saveResource

    public void saveResource(SpaceEntry sentry,
                             Resource resource)

  Save this resource to the space.
  Parameters:
    `sentry` - The resource space entry.
    `resource` - The resource to save.

### markModified

    public void markModified(SpaceEntry sentry,
                             Resource resource)

  Mark the given resource as being modified.
  Parameters:
    `sentry` - The resource space entry.
    `resource` - The resource to mark as modified.

### renameResource

    public void renameResource(SpaceEntry sentry,
                               java.lang.String oldid,
                               java.lang.String newid)

  Rename a resource in this resource space.
  Parameters:
    `sentry` - The resource space entry.
    `oldid` - The old resorce identifier.
    `newid` - The new resorce identifier.

### deleteResource

    public void deleteResource(SpaceEntry sentry,
                               Resource resource)

  Delete this resource from the space.
  Parameters:
    `sentry` - The resource space entry.
    `resource` - The resource to delete.

### deleteChildren

    public void deleteChildren(SpaceEntry sentry)

  Delete all the children of resource indentified by its space entry.
  Parameters:
    `sentry` - The resource space entry

### saveChildren

    public void saveChildren(SpaceEntry sentry)

  Save all the children of the resource indentified by its spaec entry.
  Parameters:
    `sentry` - The resource space entry

### acquireChildren

    public void acquireChildren(SpaceEntry sentry)

  Acquire the children of the resource.
  Parameters:
    `sentry` - The resource space entry.

### acquireChildren

    public void acquireChildren(SpaceEntry sentry,
                                java.io.File repository,
                                boolean transientFlag)

  acquire children from an external file.
  Parameters:
    `sentry` - The resource space entry.
    `repository` - The file used to store children.

### enumerateResourceIdentifiers

    public java.util.Enumeration enumerateResourceIdentifiers(SpaceEntry sentry)

  Enumerate the name (ie identifiers) of the resource children identified by its space entry.
  Parameters:
    `sentry` - The space entry.
  Returns:
    An enumeration, providing one element per child, which is the name of the child, as a String.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD