org.opensocial.models

Class Model

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

org.json.simple.JSONObject

org.opensocial.models.Model

All Implemented Interfaces:

Serializable, Cloneable, Map, org.json.simple.JSONAware, org.json.simple.JSONStreamAware

Direct Known Subclasses:

Activity, Album, AppData, Comment, Group, MediaItem, Message, MessageCollection, Notification, Person, StatusMood

public class Model
extends org.json.simple.JSONObject

Generic OpenSocial model class. Every OpenSocial resource class, whether it models concrete (e.g. person) or abstract (e.g. AppData) concepts, extends this class. Instance methods provide an interface for getting and setting arbitrary properties (fields) of these resources.

Author:

Jason Cooper

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Model()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addTemplateParameter(String name, String value) Adds a new template parameter with the specified name and value.
protected void	addToListField(String fieldName, Object item) Adds the passed Object to the list field with the specified name.
Object	getField(String fieldName) Returns the value of the specified field as an Object.
List	getFieldAsList(String fieldName) Returns the value of the specified field as a List.
Map	getFieldAsMap(String fieldName) Returns the value of the specified field as a Map.
String	getFieldAsString(String fieldName) Returns the value of the specified field as a String.
String[]	getFieldNames() Returns the complete set of properties associated with the model instance.
protected String	getTemplateParameter(String name) Returns the template parameter with the specified name.
boolean	hasField(String fieldName) Returns true if a value is associated with the specified field name, false otherwise.
boolean	isFieldMultikeyed(String fieldName) Returns true if the value of the specified field implements Map, false otherwise.
boolean	isFieldMultivalued(String fieldName) Returns true if the value of the specified field implements List, false otherwise.
void	setField(String fieldName, Object value) Sets the value of the specified field to the passed Object.

Methods inherited from class org.json.simple.JSONObject

escape, toJSONString, toJSONString, toString, toString, writeJSONString, writeJSONString

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

Model

public Model()

Method Detail

getFieldNames

public String[] getFieldNames()

Returns the complete set of properties associated with the model instance.

hasField

public boolean hasField(String fieldName)

Returns true if a value is associated with the specified field name, false otherwise.

Parameters:

fieldName - name of field to look up

getField

public Object getField(String fieldName)

Returns the value of the specified field as an Object.

Parameters:

fieldName - name of field whose value is to be returned

getFieldAsMap

public Map getFieldAsMap(String fieldName)

Returns the value of the specified field as a Map. Equivalent to (Map) getField(fieldName), hence this method will throw a ClassCastException if the field does not implement Map.

Parameters:

fieldName - name of field whose value is to be returned

See Also:

ClassCastException

getFieldAsList

public List getFieldAsList(String fieldName)

Returns the value of the specified field as a List. Equivalent to (List) getField(fieldName), hence this method will throw a ClassCastException if the field does not implement List.

Parameters:

fieldName - name of field whose value is to be returned

See Also:

ClassCastException

getFieldAsString

public String getFieldAsString(String fieldName)

Returns the value of the specified field as a String. Equivalent to (String) getField(fieldName), hence this method will throw a ClassCastException if the field is not of type String.

Parameters:

fieldName - name of field whose value is to be returned

See Also:

ClassCastException

getTemplateParameter

protected String getTemplateParameter(String name)

Returns the template parameter with the specified name.

Parameters:

name - name of template parameter whose value is to be returned

isFieldMultikeyed

public boolean isFieldMultikeyed(String fieldName)

Returns true if the value of the specified field implements Map, false otherwise.

Parameters:

fieldName - name of field to look up

isFieldMultivalued

public boolean isFieldMultivalued(String fieldName)

Returns true if the value of the specified field implements List, false otherwise.

Parameters:

fieldName - name of field to look up

setField

public void setField(String fieldName,
            Object value)

Sets the value of the specified field to the passed Object.

Parameters:

fieldName - name of field to set

value - object to associate with passed field name

addToListField

protected void addToListField(String fieldName,
                  Object item)

Adds the passed Object to the list field with the specified name.

Parameters:

fieldName - name of list field for which the passed item should be added

item - item to add

addTemplateParameter

protected void addTemplateParameter(String name,
                        String value)

Adds a new template parameter with the specified name and value.

Parameters:

name - name of new template parameter to add

value - value of template parameter to associate with passed name