org.polliwog.fields
Class AbstractField

java.lang.Object
  org.polliwog.fields.AbstractField

Direct Known Subclasses:

AbstractURIField, BlankField, DateTimeField, HostnameField, RequestHeaderField, SizeField, StatusCodeField, UserField

public abstract class AbstractField
extends java.lang.Object

The base field definition, just defines what a field should "look like".

 Last Modified By: $Author: barrygently $
 Last Modified On: $Date: 2005/07/04 14:00:01 $
 Current Revision: $Revision: 1.3 $
 

Constructor Summary

AbstractField()

Method Summary

abstract void	clear() Clear the data that the field holds.
abstract int	getFieldId() Should return a unique id for this field, this is to help with classes (such as: Hit) that use this id to help in identification.
abstract void	init(java.util.Map params, java.lang.String value) The init method.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractField

public AbstractField()

Method Detail

init

public abstract void init(java.util.Map params,
                          java.lang.String value)
                   throws WeblogException

The init method.

Parameters:

params - A Map of name/value pairs that are used to init the field.

value - The value of the field.

Throws:

WeblogException - Throw if something is wrong with the value.

clear

public abstract void clear()

Clear the data that the field holds.

getFieldId

public abstract int getFieldId()

Should return a unique id for this field, this is to help with classes (such as: Hit) that use this id to help in identification.

Returns:

A unique id.