+DatabaseItem +

From df7d7981b56a4560c95ea7e9b194080e93398ecf Mon Sep 17 00:00:00 2001 From: Matt Windsor Date: Mon, 21 Mar 2011 21:54:31 +0000 Subject: GREAT PACKAGE RESHUFFLE: Everything is now organised into frontend, backend and common (to frontend and backend) packages. Things may have been broken. Doc refresh. --- doc/uk/org/ury/backend/database/DatabaseItem.html | 320 ++++++++++++++++++++++ 1 file changed, 320 insertions(+) create mode 100644 doc/uk/org/ury/backend/database/DatabaseItem.html (limited to 'doc/uk/org/ury/backend/database/DatabaseItem.html') diff --git a/doc/uk/org/ury/backend/database/DatabaseItem.html b/doc/uk/org/ury/backend/database/DatabaseItem.html new file mode 100644 index 0000000..1d98e28 --- /dev/null +++ b/doc/uk/org/ury/backend/database/DatabaseItem.html @@ -0,0 +1,320 @@ + + + + + + +DatabaseItem + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

+ +

+ PREV CLASS + NEXT CLASS

+ FRAMES + NO FRAMES + + + + +

+ SUMMARY: NESTED | FIELD | CONSTR | METHOD

+DETAIL: FIELD | CONSTR | METHOD

+ + + +

+ +

+ +uk.org.ury.backend.database +
+Class DatabaseItem<E,T>

+java.lang.Object
+  uk.org.ury.backend.database.DatabaseItem<E,T>
+

Direct Known Subclasses:: LibraryItem, ShowItem

public abstract class DatabaseItem<E,T>
extends java.lang.Object
extends java.lang.Object

+ + +

+An abstract class presenting a template for objects serving as a data + structure for collections of properties retrieved from a SQL database. +

+ +

Author:: Matt Windsor

+ +

+ + + + + + + + + + + +
+Constructor Summary
DatabaseItem(java.util.Map<E,T> properties) + +
+          Construct a new item from an existing list of properties.
+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.util.Map<java.lang.String,java.lang.String> asResponse() + +
+          Retrieve a map of string representations of the properties.
+ T get(E property) + +
+          Query this item for a property.
+ boolean has(E property) + +
+          Check whether a property has been set in the item.
+ + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ +

+Constructor Summary
`DatabaseItem(java.util.Map<E,T> properties)` + + + Construct a new item from an existing list of properties.

+Method Summary
+ `java.util.Map<java.lang.String,java.lang.String>`	`asResponse()` + + + Retrieve a map of string representations of the properties.
+ `T`	`get(E property)` + + + Query this item for a property.
+ `boolean`	`has(E property)` + + + Check whether a property has been set in the item.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

+ + + + + + + + +
+Constructor Detail
+ +

+DatabaseItem

+public DatabaseItem(java.util.Map<E,T> properties)

Construct a new item from an existing list of properties. +

Parameters:: properties - The map of properties that the new item will inherit.

+ + + + + + + + +

+Method Detail

+ +

+has

+public boolean has(E property)

Check whether a property has been set in the item. +

Returns:: true if the property has been set; false otherwise.

+ +

+get

+public T get(E property)
+      throws MissingPropertyException

Query this item for a property. +

Parameters:: property - The property to query. +
Returns:: The property, if it exists. +
Throws: +: MissingPropertyException - if the property does not exist.

+ +

+asResponse

+public java.util.Map<java.lang.String,java.lang.String> asResponse()

Retrieve a map of string representations of the properties. + + This relies on E and T having meaningful toString methods. +

Returns:: a list of lines representing the response.

+ +