ResourceCollection (Unidata IDV API v6.3)

java.lang.Object
- ucar.unidata.util.ResourceCollection

Direct Known Subclasses:

XmlResourceCollection
```
public class ResourceCollection
extends java.lang.Object
```
Version:

$Revision: 1.47 $ $Date: 2006/10/30 18:10:31 $

Author:

Metapps development team

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ResourceCollection.Resource
Class Resource holds a string path which may be a file, url or java resource path.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ResourceCollection.Resource` Class Resource holds a string path which may be a file, url or java resource path.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`description` The description
`protected java.lang.String`	`id` The id of this collection
`protected java.util.Hashtable`	`idToPath` A mapping from id (String) to the resource path
`protected java.util.Hashtable`	`pathToId` A mapping from resource path to id
`protected int`	`writableIndex` Index of the writable index
`protected ResourceCollection.Resource`	`writableResource` Path to the writable resource

Constructor Summary

Constructors
Constructor and Description
`ResourceCollection(java.lang.String id)` Create a ResourceCollection with the given id.
`ResourceCollection(java.lang.String id, java.util.List resources)` Ctor
`ResourceCollection(java.lang.String id, ResourceCollection that)` copy ctor
`ResourceCollection(java.lang.String id, java.lang.String description)` Create a ResourceCollection with the given id ad description
`ResourceCollection(java.lang.String id, java.lang.String writable, java.util.List resources)` Deprecated. not good anymore

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addLabels(java.util.Hashtable labelMap)` Deprecated. not used anymore
`void`	`addResource(ResourceCollection.Resource resource)` Add the resource.
`void`	`addResource(java.lang.String resource)` Add the resource.
`void`	`addResourceAtStart(ResourceCollection.Resource resource)` Add the given resource to the beginning of the list
`void`	`addResourceAtStart(java.lang.String resourcePath)` Add the resource.
`void`	`addResourceAtStart(java.lang.String resourcePath, java.lang.String label)` Add the given resource to the beginning of the list
`void`	`addResources(java.util.List rs)` Add the list of resources
`void`	`clearCache()` Clear the cache
`boolean`	`contains(java.lang.String path)` Do we contain the given path
`void`	`deleteAllFiles()` Delete, if possible, all resource files.
`java.lang.Object`	`get(int i)` Return the name of the i'th resource
`boolean`	`getCanLoadMore()` Should we keep loading resources from this collection.
`java.lang.String`	`getDescription()` Get the Description property.
`java.lang.String`	`getId()` The id of the resource collection
`java.lang.String`	`getLabel(int resourceIdx)` Return the label (or null if none defined) for the given resource.
`java.lang.String`	`getPathFromId(java.lang.String id)` Find the path for the given id
`java.lang.String`	`getProperty(java.lang.String name, int resourceIdx)` Get the named property from the given resource
`java.lang.String`	`getResourceId(int idx)` Find the id for the given resource index
`java.util.List`	`getResources()` Get the list of resources
`java.lang.String`	`getShortName(int resourceIdx)` Return an abbreviated name of the given resource for display purposes.
`java.lang.String`	`getWritable()` Get the string path of the writable file resource.
`boolean`	`hasWritableResource()` Do we have a writable resource
`boolean`	`isHttp(int i)` Is the given index an http based path
`boolean`	`isHttp(java.lang.String resource)` Is the given path an http based path
`boolean`	`isValid(int i)` Is the given resource index valid.
`boolean`	`isWritable(int i)` Is the i'th resource writable
`boolean`	`isWritableResource(int i)` Is the ith resource a writable resource
`java.lang.String`	`read(int i)` Read the ith resource
`java.lang.String`	`read(int i, boolean lookAtCache)` Read the ith resource
`protected java.lang.String`	`read(ResourceCollection.Resource resource, boolean lookAtCache)` Read and return the contents of the resource.
`java.lang.String`	`readWritableResource()` Read in the writable resource file
`void`	`removeAll()` Reset all structures
`void`	`removeResource(int index)` Remove the index'th resource
`void`	`removeWritable()` Delete, if possible, the writable resource file
`void`	`setCanLoadMore(boolean lm)` Set if we can keep loading resources
`void`	`setDescription(java.lang.String value)` Set the Description property.
`void`	`setId(java.lang.String id)` Set the id of the resource collection
`void`	`setIdForPath(java.lang.String id, java.lang.String path)` Associate the resource id with the path
`int`	`size()` How many resources
`java.lang.String`	`toString()` The toString method
`void`	`writeWritableResource(java.lang.String contents)` Write the given contents into the writable resource file

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - id
```
protected java.lang.String id
```
    The id of this collection
  - description
```
protected java.lang.String description
```
    The description
  - idToPath
```
protected java.util.Hashtable idToPath
```
    A mapping from id (String) to the resource path
  - pathToId
```
protected java.util.Hashtable pathToId
```
    A mapping from resource path to id
  - writableResource
```
protected ResourceCollection.Resource writableResource
```
    Path to the writable resource
  - writableIndex
```
protected int writableIndex
```
    Index of the writable index
- Constructor Detail
  - ResourceCollection
```
public ResourceCollection(java.lang.String id)
```
    Create a ResourceCollection with the given id. The description of this collection is the id.
    
    Parameters:
    
    id - The id of this ResourceCollection
  - ResourceCollection
```
public ResourceCollection(java.lang.String id,
                          java.lang.String description)
```
    Create a ResourceCollection with the given id ad description
    
    Parameters:
    
    id - The id of this ResourceCollection
    
    description - The description of this ResourceCollection
  - ResourceCollection
```
public ResourceCollection(java.lang.String id,
                          java.util.List resources)
```
    Ctor
    
    Parameters:
    
    id - Resource id
    
    resources - List of resources
  - ResourceCollection
```
public ResourceCollection(java.lang.String id,
                          java.lang.String writable,
                          java.util.List resources)
```
    Deprecated. not good anymore
    
    Ctor
    
    Parameters:
    
    id - Resource id
    
    resources - List of resources
    
    writable - The writable resource
  - ResourceCollection
```
public ResourceCollection(java.lang.String id,
                          ResourceCollection that)
```
    copy ctor
    
    Parameters:
    
    id - new id
    
    that - resourcecollection to copy from
- Method Detail
  - contains
```
public boolean contains(java.lang.String path)
```
    Do we contain the given path
    
    Parameters:
    
    path - the resource path
    
    Returns:
    
    do we contain the resource path
  - setIdForPath
```
public void setIdForPath(java.lang.String id,
                         java.lang.String path)
```
    Associate the resource id with the path
    
    Parameters:
    
    id - The id
    
    path - The path
  - getPathFromId
```
public java.lang.String getPathFromId(java.lang.String id)
```
    Find the path for the given id
    
    Parameters:
    
    id - The id
    
    Returns:
    
    The path
  - getResourceId
```
public java.lang.String getResourceId(int idx)
```
    Find the id for the given resource index
    
    Parameters:
    
    idx - The resource index
    
    Returns:
    
    The id. May be null.
  - getCanLoadMore
```
public boolean getCanLoadMore()
```
    Should we keep loading resources from this collection. Have we seen the loadmore=false yet.
    
    Returns:
    
    Keep loading resources
  - setCanLoadMore
```
public void setCanLoadMore(boolean lm)
```
    Set if we can keep loading resources
    
    Parameters:
    
    lm - value
  - getId
```
public java.lang.String getId()
```
    The id of the resource collection
    
    Returns:
    
    resource id
  - setId
```
public void setId(java.lang.String id)
```
    Set the id of the resource collection
    
    Parameters:
    
    id - The id
  - isValid
```
public boolean isValid(int i)
```
    Is the given resource index valid. We try to read that resource.
    
    Parameters:
    
    i - Resource index
    
    Returns:
    
    Do we have it
  - getLabel
```
public java.lang.String getLabel(int resourceIdx)
```
    Return the label (or null if none defined) for the given resource.
    
    Parameters:
    
    resourceIdx -
    
    Returns:
    
    A short name for the given resource.
  - getProperty
```
public java.lang.String getProperty(java.lang.String name,
                                    int resourceIdx)
```
    Get the named property from the given resource
    
    Parameters:
    
    name - property name
    
    resourceIdx - which resource
    
    Returns:
    
    property value or null
  - getShortName
```
public java.lang.String getShortName(int resourceIdx)
```
    Return an abbreviated name of the given resource for display purposes.
    
    Parameters:
    
    resourceIdx -
    
    Returns:
    
    A short name for the given resource.
  - addLabels
```
public void addLabels(java.util.Hashtable labelMap)
```
    Deprecated. not used anymore
    
    Add in the given maps of path to label.
    
    Parameters:
    
    labelMap - Pat to label map
  - addResources
```
public void addResources(java.util.List rs)
```
    Add the list of resources
    
    Parameters:
    
    rs - List of Resource-s
  - removeResource
```
public void removeResource(int index)
```
    Remove the index'th resource
    
    Parameters:
    
    index - the index to remove
  - addResource
```
public void addResource(java.lang.String resource)
```
    Add the resource. We create a new Resource
    
    Parameters:
    
    resource - The resource path
  - addResource
```
public void addResource(ResourceCollection.Resource resource)
```
    Add the resource.
    
    Parameters:
    
    resource - The resource
  - addResourceAtStart
```
public void addResourceAtStart(java.lang.String resourcePath)
```
    Add the resource.
    
    Parameters:
    
    resourcePath - the path to the resource
  - addResourceAtStart
```
public void addResourceAtStart(java.lang.String resourcePath,
                               java.lang.String label)
```
    Add the given resource to the beginning of the list
    
    Parameters:
    
    resourcePath - resource path
    
    label - label
  - addResourceAtStart
```
public void addResourceAtStart(ResourceCollection.Resource resource)
```
    Add the given resource to the beginning of the list
    
    Parameters:
    
    resource - The resource
  - size
```
public int size()
```
    How many resources
    
    Returns:
    
    How many resources
  - isWritable
```
public boolean isWritable(int i)
```
    Is the i'th resource writable
    
    Parameters:
    
    i - Resource index
    
    Returns:
    
    Is it a writable file
  - isHttp
```
public boolean isHttp(java.lang.String resource)
```
    Is the given path an http based path
    
    Parameters:
    
    resource - Resource path
    
    Returns:
    
    Is it http
  - isHttp
```
public boolean isHttp(int i)
```
    Is the given index an http based path
    
    Parameters:
    
    i - Resource index
    
    Returns:
    
    Is it http
  - get
```
public java.lang.Object get(int i)
```
    Return the name of the i'th resource
    
    Parameters:
    
    i - The resource index
    
    Returns:
    
    The name of the i'th resource
  - isWritableResource
```
public boolean isWritableResource(int i)
```
    Is the ith resource a writable resource
    
    Parameters:
    
    i - Resource index
    
    Returns:
    
    is writable
  - readWritableResource
```
public java.lang.String readWritableResource()
```
    Read in the writable resource file
    
    Returns:
    
    The writable resource contents or null
  - writeWritableResource
```
public void writeWritableResource(java.lang.String contents)
                           throws java.io.FileNotFoundException,
                                  java.io.IOException
```
    Write the given contents into the writable resource file
    
    Parameters:
    
    contents -
    
    Throws:
    
    java.io.FileNotFoundException
    
    java.io.IOException
  - read
```
protected java.lang.String read(ResourceCollection.Resource resource,
                                boolean lookAtCache)
```
    Read and return the contents of the resource. Return null if cannot be read.
    
    Parameters:
    
    resource - The resource
    
    lookAtCache - Should we look in the cache or reread
    
    Returns:
    
    Contents or null
  - read
```
public java.lang.String read(int i,
                             boolean lookAtCache)
```
    Read the ith resource
    
    Parameters:
    
    i - The resource index
    
    lookAtCache - Should we look in the cache or reread
    
    Returns:
    
    Contents or null
  - read
```
public java.lang.String read(int i)
```
    Read the ith resource
    
    Parameters:
    
    i - The resource index
    
    Returns:
    
    Contents or null
  - getResources
```
public java.util.List getResources()
```
    Get the list of resources
    
    Returns:
    
    List of resources
  - removeWritable
```
public void removeWritable()
```
    Delete, if possible, the writable resource file
  - clearCache
```
public void clearCache()
```
    Clear the cache
  - deleteAllFiles
```
public void deleteAllFiles()
```
    Delete, if possible, all resource files.
  - removeAll
```
public void removeAll()
```
    Reset all structures
  - getWritable
```
public java.lang.String getWritable()
```
    Get the string path of the writable file resource.
    
    Returns:
    
    File path
  - hasWritableResource
```
public boolean hasWritableResource()
```
    Do we have a writable resource
    
    Returns:
    
    Do we have a writable resource
  - toString
```
public java.lang.String toString()
```
    The toString method
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String representation
  - setDescription
```
public void setDescription(java.lang.String value)
```
    Set the Description property.
    
    Parameters:
    
    value - The new value for Description
  - getDescription
```
public java.lang.String getDescription()
```
    Get the Description property.
    
    Returns:
    
    The Description

Class ResourceCollection

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

description

idToPath

pathToId

writableResource

writableIndex

Constructor Detail

ResourceCollection

ResourceCollection

ResourceCollection

ResourceCollection

ResourceCollection

Method Detail

contains

setIdForPath

getPathFromId

getResourceId

getCanLoadMore

setCanLoadMore

getId

setId

isValid

getLabel

getProperty

getShortName

addLabels

addResources

removeResource

addResource

addResource

addResourceAtStart

addResourceAtStart

addResourceAtStart

size

isWritable

isHttp

isHttp

get

isWritableResource

readWritableResource

writeWritableResource

read

read

read

getResources

removeWritable

clearCache

deleteAllFiles

removeAll

getWritable

hasWritableResource

toString

setDescription

getDescription