jreceiver.common.rec.site
Class RootKey

java.lang.Object
  |
  +--jreceiver.common.rec.BaseRec
        |
        +--jreceiver.common.rec.site.RootKey
All Implemented Interfaces:
Hashable, Key

public class RootKey
extends BaseRec
implements Key

An interface describing a root

Version:
$Revision: 1.3 $ $Date: 2002/12/29 00:44:08 $
Author:
Reed Esau

Field Summary
protected  java.io.File file_path
          the physical file path for the root
static java.lang.String HKEY_FILE_PATH
           
static java.lang.String HKEY_SITE_ID
           
protected  int site_id
          The site on which this root exists.
 
Constructor Summary
RootKey(java.util.Hashtable hash)
          ctor - construct from a hashtable, usually retrieved via XML-RPC
RootKey(int site_id, java.io.File file_path)
          ctor
 
Method Summary
 boolean equals(java.lang.Object obj)
          Indicates whether some other object is "equal to" this one.
 java.io.File getFilePath()
           
 java.lang.String getPath()
          for retrieval via struts
 int getSiteId()
           
 void setPath(java.lang.String path)
          placeholder for odd call by struts to set the path.
 java.util.Hashtable toHash()
          Store the object as a hash suitable for transport over an XML-RPC connection or similar.
 java.lang.String toString()
          Returns a string representation of the object.
 
Methods inherited from class jreceiver.common.rec.BaseRec
dissolve, dissolveMap, find, find, find, find
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

HKEY_SITE_ID

public static final java.lang.String HKEY_SITE_ID

HKEY_FILE_PATH

public static final java.lang.String HKEY_FILE_PATH

file_path

protected java.io.File file_path
the physical file path for the root

site_id

protected int site_id
The site on which this root exists.

Site.SITE_HOME is the current machine.

Constructor Detail

RootKey

public RootKey(int site_id,
               java.io.File file_path)
ctor

RootKey

public RootKey(java.util.Hashtable hash)
ctor - construct from a hashtable, usually retrieved via XML-RPC
Parameters:
hash -  
Method Detail

equals

public boolean equals(java.lang.Object obj)
Indicates whether some other object is "equal to" this one.
Overrides:
equals in class java.lang.Object

getSiteId

public int getSiteId()

getFilePath

public java.io.File getFilePath()

getPath

public java.lang.String getPath()
for retrieval via struts

setPath

public void setPath(java.lang.String path)
placeholder for odd call by struts to set the path. Not sure yet why it's needed.

toHash

public java.util.Hashtable toHash()
Store the object as a hash suitable for transport over an XML-RPC connection or similar.

Use RootRec(Hashtable) to transform the data back into an object of this type.

Specified by:
toHash in interface Hashable
Returns:
 

toString

public java.lang.String toString()
Description copied from interface: Hashable
Returns a string representation of the object.
Specified by:
toString in interface Hashable
Overrides:
toString in class java.lang.Object


Copyright © 2001-2002 Reed Esau, All Rights Reserved.