org.starhope.appius.game
Class InventoryItem

java.lang.Object
  org.starhope.appius.sql.SQLPeerDatum
      org.starhope.appius.game.InventoryItem

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ClothingItem, GameEquipItem, HomeDecorItem, MusicItem, NamedInventoryItem, Stationery, TootBookTheme

public abstract class InventoryItem
extends SQLPeerDatum

The InventoryItem is an abstract superclass for all items which can be placed into the user's inventory. It also has interface elements for the common behaviour of “equipping” the item in some way, giving and receiving items (including purchasing them and trading with other players), and so forth. Subclasses are ClothingItem, HomeDecorItem, MusicItem , GameEquipItem

Author:

brpocock

See Also:

Serialized Form

Field Summary

protected boolean	active TODO: document this field (brpocock, Nov 19, 2009) active (InventoryItem)
static String	CLOTHES WRITEME: Document this field.
static String	FURNITURE String for identifiesAs(String) for furniture
static String	GAME_EQUIP_ITEM String for identifiesAs(String) for game equippable items
protected int	id
static String	MUSIC String for identifiesAs(String) for music
protected int	ownerID user owning this item
static String	PATTERNS WRITEME: Document this field.
private static String	PET WRITEME: Document this field.
static String	PIVITZ WRITEME: Document this field.
private static long	serialVersionUID Java serialization version unique ID serialVersionUID (long)
protected int	slotNumber The slot/series in which this occurs in the player's inventory
static String	STATIONERY WRITEME: Document this field.
static String	STRUCTURE WRITEME: Document this field.
static InventoryItemType	T_Backpacks Backpacks, færie wings, and the like (clothing)
static InventoryItemType	T_Ceiling ceilings for houses (structure)
static InventoryItemType	T_Ceiling_Furniture WRITEME
static InventoryItemType	T_Dresses WRITEME
static InventoryItemType	T_Ears WRITEME
static InventoryItemType	T_Eyes WRITEME
static InventoryItemType	T_Floor_Furniture WRITEME
static InventoryItemType	T_Flooring WRITEME
static InventoryItemType	T_Game_Equip_Item TODO: document this field (brpocock, Nov 19, 2009) T_Game_Equip_Item (InventoryItem)
static InventoryItemType	T_Music WRITEME
static InventoryItemType	T_Neck WRITEME
static InventoryItemType	T_Orbitz WRITEME
static InventoryItemType	T_Pants WRITEME
static InventoryItemType	T_Pattern WRITEME
static InventoryItemType	T_Pet TODO: document this field (brpocock, Nov 24, 2009) T_Pet (InventoryItem)
static InventoryItemType	T_Pivitz WRITEME
static InventoryItemType	T_Shirts WRITEME
static InventoryItemType	T_Stationery TODO: document this field (brpocock, Nov 19, 2009) T_Stationery (InventoryItem)
static InventoryItemType	T_TootBook_Avatar_BG TODO: document this field (brpocock, Nov 19, 2009) T_Stationery (InventoryItem)
static InventoryItemType	T_TootBook_Box_Style TODO: document this field (brpocock, Nov 19, 2009) T_Stationery (InventoryItem)
static InventoryItemType	T_TootBook_Icon TODO: document this field (brpocock, Nov 19, 2009) T_Stationery (InventoryItem)
static InventoryItemType	T_TootBook_Page_BG TODO: document this field (brpocock, Nov 19, 2009) T_Stationery (InventoryItem)
static InventoryItemType	T_TootBook_Title_BG TODO: document this field (brpocock, Nov 19, 2009) T_Stationery (InventoryItem)
static InventoryItemType	T_TootBookTheme TODO: document this field (brpocock, Nov 19, 2009) T_TootBookTheme (InventoryItem)
static InventoryItemType	T_Tops WRITEME
static InventoryItemType	T_Vehicle TODO: document this field (brpocock, Nov 24, 2009) T_Vehicle (InventoryItem)
static InventoryItemType	T_Wall_Furniture WRITEME
static InventoryItemType	T_Wallpaper WRITEME
static String	TB_AVATAR_BG WRITEME: Document this field.
static String	TB_BOX_STYLES WRITEME: Document this field.
static String	TB_ICON WRITEME: Document this field.
static String	TB_PAGE_BG WRITEME: Document this field.
static String	TB_TITLE_BG WRITEME: Document this field.
protected InventoryItemType	type WRITEME
static int	Type_Backpacks WRITEME
static int	Type_Ceiling WRITEME
static int	Type_Ceiling_Furniture WRITEME
static int	Type_Dresses WRITEME
static int	Type_Ears WRITEME
static int	Type_Eyes WRITEME
static int	Type_Floor_Furniture WRITEME
static int	Type_Flooring WRITEME
static int	Type_Music WRITEME
static int	Type_Neck WRITEME
static int	Type_Orbitz WRITEME
static int	Type_Pants WRITEME
static int	Type_Pattern WRITEME
static int	Type_Pivitz WRITEME
static int	Type_Shirts WRITEME
static int	Type_Tops WRITEME
static int	Type_Wall_Furniture WRITEME
static int	Type_Wallpaper WRITEME
private static String	VEHICLE WRITEME: Document this field.

Fields inherited from class org.starhope.appius.sql.SQLPeerDatum

hackyDatabaseConnection

Constructor Summary

InventoryItem()

Method Summary

ClothingItem	asClothing()
HomeDecorItem	asHomeDecorItem()
protected abstract void	assertValidType(InventoryItemType t) TODO: document this method (brpocock, Nov 19, 2009)
protected void	assertValidTypeID(long testTypeID) This is for subclasses to validate the type ID of their members.
boolean	equals(Object obj)
void	equip() TODO: document this method (brpocock, Nov 24, 2009)
void	flush() This is an overriding method.
static InventoryItem	getByID(int idByWhichToGet) Get an inventory item based upon the database ID
static InventoryItem	getByID(int id, boolean isActive, int slotNum) WRITEME: document this method (brpocock, Aug 28, 2009)
String	getCacheUniqueID()
Class<? extends InventoryItem>	getClassForThisType()
static Class<? extends InventoryItem>	getClassForType(int theTypeID) Find the class to which a type of item belongs.
static Class<? extends InventoryItem>	getClassForType(InventoryItemType theType) TODO: document this method (brpocock, Nov 19, 2009)
static InventoryItem	getFromInventory(ResultSet inv)
int	getID()
Class<? extends InventoryItem>	getItemClass()
String	getMountPoint()
User	getOwner()
int	getOwnerID()
int	getSlotNumber()
InventoryItemType	getType() WRITEME
int	getTypeID()
static InventoryItemType[]	getTypesOfClothingT()
static InventoryItemType[]	getTypesOfFurnitureT()
static InventoryItemType[]	getTypesOfHomeDecorT() TODO: document this method (brpocock, Nov 19, 2009)
static InventoryItemType[]	getTypesOfStructureT()
static InventoryItemType[]	getTypesOfWearablesT()
boolean	hasANomen() True if this is a nominable type of item
int	hashCode() This is an overriding method.
boolean	identifiesAs(String typeString) Compares a string against a list of constants to retrieve an item type.
boolean	isActive() WRITEME: document this method (brpocock, Aug 28, 2009)
boolean	isAPet() TODO: document this method (brpocock, Nov 24, 2009)
boolean	isClothingOnly()
boolean	isFurniture()
private boolean	isGameEquipItem()
boolean	isMusic()
boolean	isPattern()
boolean	isPet() TODO: document this method (brpocock, Nov 24, 2009)
boolean	isPivitz()
private boolean	isStationery()
boolean	isStructure()
private boolean	isTootBookAvatarBG()
private boolean	isTootBookBoxStyle()
private boolean	isTootBookIcon()
private boolean	isTootBookPageBG()
private boolean	isTootBookTitleBG()
boolean	isVehicle() TODO: document this method (brpocock, Nov 25, 2009)
boolean	isWearable()
static InventoryItem	pullFromInventory(int id, int userID) WRITEME: document this method (brpocock, Sep 9, 2009)
void	setActive(boolean beActive)
protected abstract void	setFromInventory(ResultSet inv) TODO: document this method (brpocock, Nov 19, 2009)
void	setOwner(User user)
void	setOwnerID(int ownerID1)
void	setSlotHarsh(int slotNumber_force) This is only to be used by addItem.
void	setSlotNumber(int slot)
void	setType(InventoryItemType type2) WRITEME
void	setTypeID(int typeID1)
org.json.JSONObject	toJSON() This is the default SQLPeerDatum implementation of toJSON.
String	toString() This is an overriding method.
void	unequip() TODO: document this method (brpocock, Nov 24, 2009)

Methods inherited from class org.starhope.appius.sql.SQLPeerDatum

changed, findInCache, get, prepareX, prepareX, saveInCache, set, set

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CLOTHES

public static final String CLOTHES

WRITEME: Document this field. theys Dec 15, 2009

See Also:

Constant Field Values

FURNITURE

public static final String FURNITURE

String for identifiesAs(String) for furniture

See Also:

Constant Field Values

GAME_EQUIP_ITEM

public static final String GAME_EQUIP_ITEM

String for identifiesAs(String) for game equippable items

See Also:

Constant Field Values

MUSIC

public static final String MUSIC

String for identifiesAs(String) for music

See Also:

Constant Field Values

PATTERNS

public static final String PATTERNS

WRITEME: Document this field. theys Dec 15, 2009

See Also:

Constant Field Values

PET

private static final String PET

WRITEME: Document this field. theys Dec 15, 2009

See Also:

Constant Field Values

PIVITZ

public static final String PIVITZ

WRITEME: Document this field. theys Dec 15, 2009

See Also:

Constant Field Values

serialVersionUID

private static final long serialVersionUID

Java serialization version unique ID serialVersionUID (long)

See Also:

Constant Field Values

STATIONERY

public static final String STATIONERY

WRITEME: Document this field. theys Dec 15, 2009

See Also:

Constant Field Values

STRUCTURE

public static final String STRUCTURE

WRITEME: Document this field. theys Dec 15, 2009

See Also:

Constant Field Values

T_Backpacks

public static final InventoryItemType T_Backpacks

Backpacks, færie wings, and the like (clothing)

T_Ceiling

public static final InventoryItemType T_Ceiling

ceilings for houses (structure)

T_Ceiling_Furniture

public static final InventoryItemType T_Ceiling_Furniture

WRITEME

T_Dresses

public static final InventoryItemType T_Dresses

WRITEME

T_Ears

public static final InventoryItemType T_Ears

WRITEME

T_Eyes

public static final InventoryItemType T_Eyes

WRITEME

T_Floor_Furniture

public static final InventoryItemType T_Floor_Furniture

WRITEME

T_Flooring

public static final InventoryItemType T_Flooring

WRITEME

T_Game_Equip_Item

public static final InventoryItemType T_Game_Equip_Item

TODO: document this field (brpocock, Nov 19, 2009) T_Game_Equip_Item (InventoryItem)

T_Music

public static final InventoryItemType T_Music

WRITEME

T_Neck

public static final InventoryItemType T_Neck

WRITEME

T_Orbitz

public static final InventoryItemType T_Orbitz

WRITEME

T_Pants

public static final InventoryItemType T_Pants

WRITEME

T_Pattern

public static final InventoryItemType T_Pattern

WRITEME

T_Pet

public static final InventoryItemType T_Pet

TODO: document this field (brpocock, Nov 24, 2009) T_Pet (InventoryItem)

T_Pivitz

public static final InventoryItemType T_Pivitz

WRITEME

T_Shirts

public static final InventoryItemType T_Shirts

WRITEME

T_Stationery

public static final InventoryItemType T_Stationery

TODO: document this field (brpocock, Nov 19, 2009) T_Stationery (InventoryItem)

T_TootBook_Avatar_BG

public static final InventoryItemType T_TootBook_Avatar_BG

TODO: document this field (brpocock, Nov 19, 2009) T_Stationery (InventoryItem)

T_TootBook_Box_Style

public static final InventoryItemType T_TootBook_Box_Style

TODO: document this field (brpocock, Nov 19, 2009) T_Stationery (InventoryItem)

T_TootBook_Icon

public static final InventoryItemType T_TootBook_Icon

TODO: document this field (brpocock, Nov 19, 2009) T_Stationery (InventoryItem)

T_TootBook_Page_BG

public static final InventoryItemType T_TootBook_Page_BG

TODO: document this field (brpocock, Nov 19, 2009) T_Stationery (InventoryItem)

T_TootBook_Title_BG

public static final InventoryItemType T_TootBook_Title_BG

TODO: document this field (brpocock, Nov 19, 2009) T_Stationery (InventoryItem)

T_TootBookTheme

public static final InventoryItemType T_TootBookTheme

TODO: document this field (brpocock, Nov 19, 2009) T_TootBookTheme (InventoryItem)

T_Tops

public static final InventoryItemType T_Tops

WRITEME

T_Vehicle

public static final InventoryItemType T_Vehicle

TODO: document this field (brpocock, Nov 24, 2009) T_Vehicle (InventoryItem)

T_Wall_Furniture

public static final InventoryItemType T_Wall_Furniture

WRITEME

T_Wallpaper

public static final InventoryItemType T_Wallpaper

WRITEME

TB_AVATAR_BG

public static final String TB_AVATAR_BG

WRITEME: Document this field. theys Dec 15, 2009

See Also:

Constant Field Values

TB_BOX_STYLES

public static final String TB_BOX_STYLES

WRITEME: Document this field. theys Dec 15, 2009

See Also:

Constant Field Values

TB_ICON

public static final String TB_ICON

WRITEME: Document this field. theys Dec 15, 2009

See Also:

Constant Field Values

TB_PAGE_BG

public static final String TB_PAGE_BG

WRITEME: Document this field. theys Dec 15, 2009

See Also:

Constant Field Values

TB_TITLE_BG

public static final String TB_TITLE_BG

WRITEME: Document this field. theys Dec 15, 2009

See Also:

Constant Field Values

Type_Backpacks

public static final int Type_Backpacks

WRITEME

See Also:

Constant Field Values

Type_Ceiling

public static final int Type_Ceiling

WRITEME

See Also:

Constant Field Values

Type_Ceiling_Furniture

public static final int Type_Ceiling_Furniture

WRITEME

See Also:

Constant Field Values

Type_Dresses

public static final int Type_Dresses

WRITEME

See Also:

Constant Field Values

Type_Ears

public static final int Type_Ears

WRITEME

See Also:

Constant Field Values

Type_Eyes

public static final int Type_Eyes

WRITEME

See Also:

Constant Field Values

Type_Floor_Furniture

public static final int Type_Floor_Furniture

WRITEME

See Also:

Constant Field Values

Type_Flooring

public static final int Type_Flooring

WRITEME

See Also:

Constant Field Values

Type_Music

public static final int Type_Music

WRITEME

See Also:

Constant Field Values

Type_Neck

public static final int Type_Neck

WRITEME

See Also:

Constant Field Values

Type_Orbitz

public static final int Type_Orbitz

WRITEME

See Also:

Constant Field Values

Type_Pants

public static final int Type_Pants

WRITEME

See Also:

Constant Field Values

Type_Pattern

public static final int Type_Pattern

WRITEME

See Also:

Constant Field Values

Type_Pivitz

public static final int Type_Pivitz

WRITEME

See Also:

Constant Field Values

Type_Shirts

public static final int Type_Shirts

WRITEME

See Also:

Constant Field Values

Type_Tops

public static final int Type_Tops

WRITEME

See Also:

Constant Field Values

Type_Wall_Furniture

public static final int Type_Wall_Furniture

WRITEME

See Also:

Constant Field Values

Type_Wallpaper

public static final int Type_Wallpaper

WRITEME

See Also:

Constant Field Values

VEHICLE

private static final String VEHICLE

WRITEME: Document this field. theys Dec 15, 2009

See Also:

Constant Field Values

active

protected boolean active

TODO: document this field (brpocock, Nov 19, 2009) active (InventoryItem)

id

protected int id

ownerID

protected int ownerID

user owning this item

slotNumber

protected int slotNumber

The slot/series in which this occurs in the player's inventory

type

protected InventoryItemType type

WRITEME

Constructor Detail

InventoryItem

public InventoryItem()

Method Detail

getByID

public static InventoryItem getByID(int idByWhichToGet)

Get an inventory item based upon the database ID

Parameters:

idByWhichToGet - the database ID of an inventory item of any kind

Returns:

the item in a class extending this one

getByID

public static InventoryItem getByID(int id,
                                    boolean isActive,
                                    int slotNum)

WRITEME: document this method (brpocock, Aug 28, 2009)

Parameters:

id - WRITEME

isActive - WRITEME

slotNum - WRITEME

Returns:

WRITEME

getClassForType

public static Class<? extends InventoryItem> getClassForType(int theTypeID)

Find the class to which a type of item belongs.

Parameters:

theTypeID - The ID number for a type of item

Returns:

a Class which can fully instantiate items of that type, with any special properties, which extends InventoryItem

getClassForType

public static Class<? extends InventoryItem> getClassForType(InventoryItemType theType)

TODO: document this method (brpocock, Nov 19, 2009)

Parameters:

theType - WRITEME

Returns:

WRITEME

getFromInventory

public static InventoryItem getFromInventory(ResultSet inv)

Parameters:

inv - WRITEME

Returns:

WRITEME

getTypesOfClothingT

public static InventoryItemType[] getTypesOfClothingT()

Returns:

an array of items that can be worn as clothing, excluding Patterns and Pivitz

getTypesOfFurnitureT

public static InventoryItemType[] getTypesOfFurnitureT()

Returns:

an array of furniture items that can be placed in the house

getTypesOfHomeDecorT

public static InventoryItemType[] getTypesOfHomeDecorT()

TODO: document this method (brpocock, Nov 19, 2009)

Returns:

WRITEME

getTypesOfStructureT

public static InventoryItemType[] getTypesOfStructureT()

Returns:

an array of structure items of a room

getTypesOfWearablesT

public static InventoryItemType[] getTypesOfWearablesT()

Returns:

an array of all items that can be worn, including Pivitz and patterns

pullFromInventory

public static InventoryItem pullFromInventory(int id,
                                              int userID)
                                       throws NotFoundException

WRITEME: document this method (brpocock, Sep 9, 2009)

Parameters:

id - WRITEME

userID - WRITEME

Returns:

WRITEME

Throws:

NotFoundException - WRITEME

asClothing

public ClothingItem asClothing()

Returns:

the item as a ClothingItem

asHomeDecorItem

public HomeDecorItem asHomeDecorItem()

Returns:

the item as a HomeDecorItem

assertValidType

protected abstract void assertValidType(InventoryItemType t)
                                 throws GameLogicException

TODO: document this method (brpocock, Nov 19, 2009)

Parameters:

t - WRITEME

Throws:

GameLogicException - WRITEME

assertValidTypeID

protected void assertValidTypeID(long testTypeID)
                          throws GameLogicException

This is for subclasses to validate the type ID of their members. If the specific class being instantiated can't handle the type of item, it should throw an exception.

Parameters:

testTypeID - The type ID to be checked

Throws:

GameLogicException - if the type ID is not of the types supported by this class

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

equip

public void equip()

TODO: document this method (brpocock, Nov 24, 2009)

flush

public void flush()

This is an overriding method.

Specified by:

flush in class SQLPeerDatum

See Also:

SQLPeerDatum.flush()

getCacheUniqueID

public String getCacheUniqueID()

Specified by:

getCacheUniqueID in class SQLPeerDatum

Returns:

The local (Stringified) version of an unique ID; usually the database ID column

See Also:

SQLPeerDatum.getCacheUniqueID()

getClassForThisType

public Class<? extends InventoryItem> getClassForThisType()

Returns:

the subclass that can best represent this item

getID

public int getID()

Returns:

the item's ID

getItemClass

public Class<? extends InventoryItem> getItemClass()

Returns:

the class which best (most specifically) represents the given item type

getMountPoint

public String getMountPoint()

Returns:

the mount point of the clothing item, or the encoded string describing the location of a furniture item

getOwner

public User getOwner()

Returns:

owner

getOwnerID

public int getOwnerID()

Returns:

owner's userID

getSlotNumber

public int getSlotNumber()

Returns:

slotNumber

getType

public InventoryItemType getType()

WRITEME

Returns:

WRITEME

getTypeID

public int getTypeID()

Returns:

the type ID

hasANomen

public boolean hasANomen()

True if this is a nominable type of item

Returns:

true, if the item can be named.

hashCode

public int hashCode()

This is an overriding method.

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

identifiesAs

public boolean identifiesAs(String typeString)

Compares a string against a list of constants to retrieve an item type.

Clothes: CLOTHES

Patterns: PATTERNS

Pivits: PIVITZ

Furniture: FURNITURE

Structure: STRUCTURE

TootBook Avatar BG: TB_AVATAR_BG

TootBook Box Styles: TB_BOX_STYLES

TootBook Icons: TB_ICON

TootBook Page BG: TB_PAGE_BG

TootBook Title BG: TB_TITLE_BG

Stationary: STATIONERY

Game Equip Item: GAME_EQUIP_ITEM

Music: MUSIC

Vehicle: VEHICLE

Pet: PET

Parameters:

typeString - the type of item from the following list of strings: "clothes" "patterns" "pivitz" "furniture" "structure" "music" "tootBookTheme" "stationery" "gameEquipItem"

Returns:

true if the item is of the specified type

isActive

public boolean isActive()

WRITEME: document this method (brpocock, Aug 28, 2009)

Returns:

true, if the item is active/in use

isAPet

public boolean isAPet()

TODO: document this method (brpocock, Nov 24, 2009)

Returns:

true, if the item is a pet that can be “walked”

isClothingOnly

public boolean isClothingOnly()

Returns:

true for clothing only (not including patterns and Pivitz)

isFurniture

public boolean isFurniture()

Returns:

true for furniture

isGameEquipItem

private boolean isGameEquipItem()

Returns:

WRITEME

isMusic

public boolean isMusic()

Returns:

true for music

isPattern

public boolean isPattern()

Returns:

true for patterns

isPet

public boolean isPet()

TODO: document this method (brpocock, Nov 24, 2009)

Returns:

true, if this is a pet

isPivitz

public boolean isPivitz()

Returns:

true for Pivitz

isStationery

private boolean isStationery()

Returns:

true, if the item is stationery

isStructure

public boolean isStructure()

Returns:

true for structure

isTootBookAvatarBG

private boolean isTootBookAvatarBG()

Returns:

WRITEME

isTootBookBoxStyle

private boolean isTootBookBoxStyle()

Returns:

WRITEME

isTootBookIcon

private boolean isTootBookIcon()

Returns:

WRITEME

isTootBookPageBG

private boolean isTootBookPageBG()

Returns:

WRITEME

isTootBookTitleBG

private boolean isTootBookTitleBG()

Returns:

WRITEME

isVehicle

public boolean isVehicle()

TODO: document this method (brpocock, Nov 25, 2009)

Returns:

true, if the item is a vehicle

isWearable

public boolean isWearable()

Returns:

true for clothing, Pivitz, and patterns

setActive

public void setActive(boolean beActive)

Parameters:

beActive - true if the item is active

setFromInventory

protected abstract void setFromInventory(ResultSet inv)
                                  throws SQLException

TODO: document this method (brpocock, Nov 19, 2009)

Parameters:

inv - WRITEME

Throws:

SQLException - WRITEME

setOwner

public void setOwner(User user)

Parameters:

user - owner

setOwnerID

public void setOwnerID(int ownerID1)

Parameters:

ownerID1 - owner's userID

setSlotHarsh

public void setSlotHarsh(int slotNumber_force)

This is only to be used by addItem. Sets the Slot number without flushing the item.

Parameters:

slotNumber_force - The retrieved slot number from an insert.

setSlotNumber

public void setSlotNumber(int slot)

Parameters:

slot - new slot number

setType

public void setType(InventoryItemType type2)

WRITEME

Parameters:

type2 - WRITEME

setTypeID

public void setTypeID(int typeID1)
               throws GameLogicException

Parameters:

typeID1 - the new type ID

Throws:

GameLogicException - if the type ID is not valid

toJSON

public org.json.JSONObject toJSON()

Description copied from class: SQLPeerDatum

This is the default SQLPeerDatum implementation of toJSON. This uses Java reflection and “bean-type” methods to extract the contents of an object and create a JSON field.

Overrides:

toJSON in class SQLPeerDatum

Returns:

This object's data, serialized into JSON form.

See Also:

SQLPeerDatum.toJSON()

toString

public String toString()

This is an overriding method.

Overrides:

toString in class Object

See Also:

Object.toString()

unequip

public void unequip()

TODO: document this method (brpocock, Nov 24, 2009)