org.cofax
Class CofaxPage

java.lang.Object
  |
  +--org.cofax.CofaxPage

public class CofaxPage

extends java.lang.Object

This is the container class of Cofax. CofaxPage contains data and metadata to be used within the Cofax framework, for example a result page's or template's data.

Author:

Rajiv Pant, Karl Martino

Constructor Summary

CofaxPage()
Default constructor

Method Summary

void	addDocId(java.lang.String docID) To be implemented.
void	append(java.lang.String s) Appends to the content field.
boolean	containsDocId(java.lang.String docid) To be implemented.
boolean	doesHeaderExist(java.lang.String headerName) Returns all headers from the page.
java.lang.String	getContents() Gets the content field's data.
int	getContentsLength() Gets the lenght of the content field.
java.util.Set	getDocIds() To be implemented.
java.lang.String	getErrorMsg() Gets the error message.
java.lang.String	getHeader(java.lang.String headerName) Gets a header.
java.util.HashMap	getHeaders() Returns all headers from the page.
int	getHitCount() Gets the hit count.
long	getLastModified() Get's the last modified time.
int	getStatus() Get's the status.
void	incrementHitCount() Increments the hitCount .
void	putHeader(java.lang.String headerName, java.lang.String headerValue) Saves a header.
void	removeDocId(java.lang.String docID) To be implemented.
void	reset() Gets the length of page's contents.
void	setDocIds(java.util.Set docIDs) To be implemented.
void	setErrorMsg(java.lang.String errorMsg) Sets the error message.
void	setLastModified(long theTime) Set's the last modified time.
void	setStatus(int status) To be implemented.
java.lang.String	toString() Get's the content's field's data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CofaxPage

public CofaxPage()

Default constructor

Method Detail

putHeader

public void putHeader(java.lang.String headerName,
                      java.lang.String headerValue)

Saves a header.

getHeader

public java.lang.String getHeader(java.lang.String headerName)

Gets a header.

getHeaders

public java.util.HashMap getHeaders()

Returns all headers from the page.

doesHeaderExist

public boolean doesHeaderExist(java.lang.String headerName)

Returns all headers from the page.

getLastModified

public long getLastModified()

Get's the last modified time.

setLastModified

public void setLastModified(long theTime)

Set's the last modified time.

toString

public java.lang.String toString()

Get's the content's field's data.

Overrides:

toString in class java.lang.Object

getContents

public java.lang.String getContents()

Gets the content field's data.

getContentsLength

public int getContentsLength()

Gets the lenght of the content field.

append

public void append(java.lang.String s)

Appends to the content field.

getStatus

public int getStatus()

Get's the status.

getErrorMsg

public java.lang.String getErrorMsg()

Gets the error message.

setErrorMsg

public void setErrorMsg(java.lang.String errorMsg)

Sets the error message.

reset

public void reset()

Gets the length of page's contents.

getHitCount

public int getHitCount()

Gets the hit count.

incrementHitCount

public void incrementHitCount()

Increments the hitCount .

setStatus

public void setStatus(int status)

To be implemented.

containsDocId

public boolean containsDocId(java.lang.String docid)

To be implemented.

getDocIds

public java.util.Set getDocIds()

To be implemented.

removeDocId

public void removeDocId(java.lang.String docID)

To be implemented.

addDocId

public void addDocId(java.lang.String docID)

To be implemented.

setDocIds

public void setDocIds(java.util.Set docIDs)

To be implemented.