net.sourceforge.nite.meta
Interface NResourceGroup

All Known Implementing Classes:

NiteResourceGroup

public interface NResourceGroup

Handles a resource-type element in a resource file. These just group resources and virtual resources into sets that instantiate the same metadata coding.

Author:

jonathan

Method Summary

void	addDefaultedResource(NResource resource) add a defaulted resource to the group
void	addRealResource(NRealResource nr) add a real resource to the group
void	addResource(NResource nr) add a resource to the group - this could be real or virtual
void	addVirtualResource(NVirtualResource nr) add a virtual resource to the group
void	deleteResource(NResource nr) remove a resource from the group - only insisting on implementation of the generic form where the NResource can be NRealResource or NVirtualResource.
java.lang.String	getCoding() get the name of the metadata coding that each resource in this group instantiates
java.util.List	getDefaultedResources() retrieve all the resources that implement the particular coding instantiated by this group and have their default attribute set to true.
java.lang.String	getDescription() return the generic description of the resource group.
java.lang.String	getPath() return the value of the 'path' attribute for this resource group.
java.util.List	getRealResources() retrieve all the (non-virtual) resources that implement the particular coding instantiated by this group
java.util.List	getVirtualResources() retrieve all the virtual resources that implement the particular coding instantiated by this group
void	setDescription(java.lang.String description) Set the value of the 'description' attribute for this resource group: a short textual description.
void	setPath(java.lang.String path) Set the value of the 'path' attribute for this resource group.

Method Detail

addResource

void addResource(NResource nr)

add a resource to the group - this could be real or virtual

addRealResource

void addRealResource(NRealResource nr)

add a real resource to the group

addVirtualResource

void addVirtualResource(NVirtualResource nr)

add a virtual resource to the group

addDefaultedResource

void addDefaultedResource(NResource resource)

add a defaulted resource to the group

getRealResources

java.util.List getRealResources()

retrieve all the (non-virtual) resources that implement the particular coding instantiated by this group

getDefaultedResources

java.util.List getDefaultedResources()

retrieve all the resources that implement the particular coding instantiated by this group and have their default attribute set to true. Note: this can return a mixed list of virtual and non-virtual resources (if the resource file writer is mental).

getVirtualResources

java.util.List getVirtualResources()

retrieve all the virtual resources that implement the particular coding instantiated by this group

getCoding

java.lang.String getCoding()

get the name of the metadata coding that each resource in this group instantiates

deleteResource

void deleteResource(NResource nr)

remove a resource from the group - only insisting on implementation of the generic form where the NResource can be NRealResource or NVirtualResource.

getPath

java.lang.String getPath()

return the value of the 'path' attribute for this resource group. This can be absolute or relative, or even a URL

setPath

void setPath(java.lang.String path)

Set the value of the 'path' attribute for this resource group. This can be absolute or relative, or even a URL - relative paths are relative to the resource file location and can be overridden by specific resource paths

getDescription

java.lang.String getDescription()

return the generic description of the resource group.

setDescription

void setDescription(java.lang.String description)

Set the value of the 'description' attribute for this resource group: a short textual description.