Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.opensymphony.module.propertyset.ofbiz
Class OFBizPropertySet

java.lang.Object
  extended bycom.opensymphony.module.propertyset.AbstractPropertySet
      extended bycom.opensymphony.module.propertyset.ofbiz.OFBizPropertySet
All Implemented Interfaces:
PropertySet, java.io.Serializable
public class OFBizPropertySet
extends AbstractPropertySet
implements java.io.Serializable

This is the property set implementation for storing properties in the OFBiz Entity Engine.

Required Args

  • entityId - Long that holds the ID of this entity
  • entityName - String that holds the name of this entity type

Optional Configuration

  • delegator.name - the name of the Ofbiz delegator, defaults to "default"

Author:
Victor Salaman, Mike Cannon-Brookes $Revision: 1.3 $
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.opensymphony.module.propertyset.AbstractPropertySet
schema
 
Fields inherited from interface com.opensymphony.module.propertyset.PropertySet
BOOLEAN, DATA, DATE, DOUBLE, INT, LONG, OBJECT, PROPERTIES, STRING, TEXT, XML
 
Constructor Summary
OFBizPropertySet()
           
 
Method Summary
 boolean exists(java.lang.String key)
          Determine if property exists.
protected  java.lang.Object get(int type, java.lang.String key)
           
 java.util.Collection getKeys()
          Calls getKeys(null,0)
 java.util.Collection getKeys(java.lang.String prefix)
          Calls getKeys(prefix,0)
 java.util.Collection getKeys(java.lang.String prefix, int type)
          List all keys starting with supplied prefix of certain type.
 int getType(java.lang.String key)
          Returns type of value.
 void init(java.util.Map config, java.util.Map args)
           
 void remove()
          Remove the propertyset and all it associated keys.
 void remove(java.lang.String key)
          Removes property.
protected  void setImpl(int type, java.lang.String key, java.lang.Object obj)
           
 boolean supportsType(int type)
          Returns true.
 
Methods inherited from class com.opensymphony.module.propertyset.AbstractPropertySet
getAsActualType, getBoolean, getData, getDate, getDouble, getInt, getKeys, getLong, getObject, getProperties, getSchema, getString, getText, getXML, isSettable, setAsActualType, setBoolean, setData, setDate, setDouble, setInt, setLong, setObject, setProperties, setSchema, setString, setText, setXML, supportsTypes, toString, type, type
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OFBizPropertySet

public OFBizPropertySet()
Method Detail

getKeys

public java.util.Collection getKeys()
                             throws PropertyException
Description copied from class: AbstractPropertySet
Calls getKeys(null,0)

Specified by:
getKeys in interface PropertySet
Overrides:
getKeys in class AbstractPropertySet
Throws:
PropertyException

getKeys

public java.util.Collection getKeys(java.lang.String prefix)
                             throws PropertyException
Description copied from class: AbstractPropertySet
Calls getKeys(prefix,0)

Specified by:
getKeys in interface PropertySet
Overrides:
getKeys in class AbstractPropertySet
Throws:
PropertyException

getKeys

public java.util.Collection getKeys(java.lang.String prefix,
                                    int type)
                             throws PropertyException
Description copied from interface: PropertySet
List all keys starting with supplied prefix of certain type. See statics.

Specified by:
getKeys in interface PropertySet
Parameters:
prefix - String that keys must start with. If null, than all keys shall be returned.
type - Type to list. See static class variables. If null, then all types shall be returned.
Returns:
Unmodifiable Collection of Strings.
Throws:
PropertyException

getType

public int getType(java.lang.String key)
            throws PropertyException
Description copied from interface: PropertySet
Returns type of value.

Specified by:
getType in interface PropertySet
Returns:
Type of value. See static class variables.
Throws:
PropertyException

exists

public boolean exists(java.lang.String key)
               throws PropertyException
Description copied from interface: PropertySet
Determine if property exists.

Specified by:
exists in interface PropertySet
Throws:
PropertyException

init

public void init(java.util.Map config,
                 java.util.Map args)
Specified by:
init in interface PropertySet
Overrides:
init in class AbstractPropertySet

remove

public void remove()
            throws PropertyException
Description copied from interface: PropertySet
Remove the propertyset and all it associated keys.

Specified by:
remove in interface PropertySet
Throws:
PropertyException - if there is an error removing the propertyset.

remove

public void remove(java.lang.String key)
            throws PropertyException
Description copied from interface: PropertySet
Removes property.

Specified by:
remove in interface PropertySet
Throws:
PropertyException

supportsType

public boolean supportsType(int type)
Description copied from class: AbstractPropertySet
Returns true.

Specified by:
supportsType in interface PropertySet
Overrides:
supportsType in class AbstractPropertySet

setImpl

protected void setImpl(int type,
                       java.lang.String key,
                       java.lang.Object obj)
                throws PropertyException
Specified by:
setImpl in class AbstractPropertySet
Throws:
PropertyException

get

protected java.lang.Object get(int type,
                               java.lang.String key)
                        throws PropertyException
Specified by:
get in class AbstractPropertySet
Throws:
PropertyException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
See www.opensymphony.com for more information.
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright 2000-2005 - OpenSymphony