javawebparts.misc.chain
Class Catalog

java.lang.Object
  |
  +--javawebparts.misc.chain.Catalog

public class Catalog
extends java.lang.Object

This class represents a Catalog.

Author:
Frank W. Zammetti.

Field Summary
private  java.util.Map chains
          The collection of Chains that belong to this Catalog..
private  java.lang.String extendsID
          The ID of the Catalog this Catalog extends, if any
private  java.lang.String id
          The ID of this Catalog.
 
Constructor Summary
Catalog()
          Constructor.
Catalog(java.lang.String inID, java.lang.String inExtendsID)
          Constructor.
 
Method Summary
 void addChain(Chain inChain)
          Adds a Chain to this Catalog.
 java.util.Map cloneChains()
          Returns a clone of the Chains collection for this Catalog.
 Chain findChain(java.lang.String inID)
          Looks up and returns a named Chain from this catalog.
 java.lang.String getExtendsID()
          Gets the ID of the Catalog that this Catalog extends.
 java.lang.String getId()
          Gets the ID of this Catalog.
 void setExtendsID(java.lang.String inExtendsID)
          Sets the ID of the Catalog that this Catalog extends.
 void setId(java.lang.String inID)
          Sets the ID of this Catalog.
 java.lang.String toString()
          Overridden toString method.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

id

private java.lang.String id
The ID of this Catalog.


extendsID

private java.lang.String extendsID
The ID of the Catalog this Catalog extends, if any


chains

private java.util.Map chains
The collection of Chains that belong to this Catalog..

Constructor Detail

Catalog

public Catalog()
Constructor. Calls the other constructor.


Catalog

public Catalog(java.lang.String inID,
               java.lang.String inExtendsID)
Constructor.

Parameters:
inID - The ID that identifies this Catalog.
inExtendsID - The ID of the Catalog that this Catalog extends. Pass null if not extending any Catalog.
Method Detail

cloneChains

public java.util.Map cloneChains()
Returns a clone of the Chains collection for this Catalog.

Returns:
The Map of Chains that exist in this Catalog.

setId

public void setId(java.lang.String inID)
Sets the ID of this Catalog.

Parameters:
inID - The ID of this Catalog.

getId

public java.lang.String getId()
Gets the ID of this Catalog.

Returns:
The ID of this Catalog.

setExtendsID

public void setExtendsID(java.lang.String inExtendsID)
Sets the ID of the Catalog that this Catalog extends.

Parameters:
inExtendsID - The ID of the Catalog this Catalog extends, if any.

getExtendsID

public java.lang.String getExtendsID()
Gets the ID of the Catalog that this Catalog extends.

Returns:
The ID of the Catalog this Catalog extends, if any.

addChain

public void addChain(Chain inChain)
Adds a Chain to this Catalog.

Parameters:
inChain - Adds the passed in Chain to this Catalog.

findChain

public Chain findChain(java.lang.String inID)
Looks up and returns a named Chain from this catalog.

Parameters:
inID - The ID of the Chain to look up in this Catalog.
Returns:
A reference to the Chain, or null if not found.

toString

public java.lang.String toString()
Overridden toString method.

Overrides:
toString in class java.lang.Object
Returns:
String representation of this bean.


Copyright 2005 Frank W. Zammetti