gps.protocol
Class Document

java.lang.Object
  gps.protocol.Document

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BTDocument

public class Document
extends java.lang.Object
implements java.io.Serializable

Document base class, all specific protocol documents inherit from it.

Version:

1.2, 6/20/2005

Author:

Weishuai Yang

See Also:

Serialized Form

Field Summary

static int	EMPTY possible document status: EMPTY, WHOLE, PARTIAL
static java.util.HashMap	mDocumentListbyID Document List by ID, each id only has one documents
static java.util.HashMap	mDocumentListbyKey Document List by Key, each key may has more than one documents
static int	PARTIAL possible document status: EMPTY, WHOLE, PARTIAL
static int	WHOLE possible document status: EMPTY, WHOLE, PARTIAL

Constructor Summary

Document()
constructs a Document object with next available id

Document(int id)
constructs a Document object with a given id

Method Summary

int	getID()
java.lang.String	getKey()
static int	getNextAvailableID() get next available id, and self increase
int	getPopularity()
double	getSize()
int	getStatus()
boolean	isEmpty()
boolean	isWhole()
static void	reset() clear all the documents in the system
void	setKey(java.lang.String newKey)
void	setPopularity(int p)
void	setSize(double newSize)
void	setStatus(int s)
void	setWhole()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

mDocumentListbyID

public static java.util.HashMap mDocumentListbyID

Document List by ID, each id only has one documents

mDocumentListbyKey

public static java.util.HashMap mDocumentListbyKey

Document List by Key, each key may has more than one documents

EMPTY

public static final int EMPTY

possible document status: EMPTY, WHOLE, PARTIAL

See Also:

Constant Field Values

WHOLE

public static final int WHOLE

possible document status: EMPTY, WHOLE, PARTIAL

See Also:

Constant Field Values

PARTIAL

public static final int PARTIAL

possible document status: EMPTY, WHOLE, PARTIAL

See Also:

Constant Field Values

Constructor Detail

Document

public Document()

constructs a Document object with next available id

Document

public Document(int id)

constructs a Document object with a given id

Method Detail

getNextAvailableID

public static int getNextAvailableID()

get next available id, and self increase

reset

public static void reset()

clear all the documents in the system

setKey

public void setKey(java.lang.String newKey)

getKey

public java.lang.String getKey()

getID

public int getID()

setSize

public void setSize(double newSize)

getSize

public double getSize()

setWhole

public void setWhole()

setStatus

public void setStatus(int s)

getStatus

public int getStatus()

isWhole

public boolean isWhole()

isEmpty

public boolean isEmpty()

getPopularity

public int getPopularity()

setPopularity

public void setPopularity(int p)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object