org.compiere.framework
Class VO

java.lang.Object
  org.compiere.framework.VO

All Implemented Interfaces:

Serializable, Map<String,String>

Direct Known Subclasses:

UIFieldVO, UITabVO, UIWindowVO

public class VO
extends Object
implements Map<String,String>, Serializable

Value Object

Version:

$Id: VO.java,v 1.3 2006/07/30 00:58:04 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

protected ArrayList<VO>	p_vos Embedded VOs
static String	XML_ATTRIBUTE_AD_Table_ID Table ID Attribute
static String	XML_ATTRIBUTE_Record_ID Record ID Attribute

Constructor Summary

VO()
Empty Constructor

VO(ArrayList<String> keys, ArrayList<String> values)
ArrayList Constructor

VO(Map<String,String> map)
Map Constructor

VO(Object[] keys, Object[] values)
Array Constructor

VO(String tableName, int table_ID, int record_ID)
Empty Constructor

VO(VO vo)
Copy Constructor

Method Summary

void	clear() Clear keys/values
VO	clone() Clone object
boolean	containsKey(Object key) Contains Key
boolean	containsValue(Object value) Contains Value
void	dump() Dump Attributes to out
Set<Map.Entry<String,String>>	entrySet() Get Values Set
Document	get_xmlDocument(boolean noComment, boolean dataOnly) Get XML Document representation
StringBuffer	get_xmlString(StringBuffer xml) Get Object xml (data only) representation as string
StringBuffer	get_xmlString(StringBuffer xml, boolean dataOnly) Get Object xml representation as string
String	get(Object key) Get Value as String of Key
String[]	getData(String[] columns) Get Data as Array positioned by column
ArrayList<VO>	getEmbedded() Get Embedded VOs
HashMap<String,String>	getHashMap() Get VO as HashMap
boolean	isEmpty() Is Empty
Set<String>	keySet() Get Key Set
String	put(Object key, Object value) Put key/value
String	put(String key, String value) Put key/value
void	putAll(Map<? extends String,? extends String> t) Put All
String	remove(Object key) Remove
void	setEmbedded(ArrayList<VO> vos) Set Embedded
void	setHdrInfo(String tableName, int table_ID, int record_ID) Set optional Header Info
int	size() Get Size
String	toString() String Representation
String	toStringX() Extended Info
Collection<String>	values() Get Values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

p_vos

protected ArrayList<VO> p_vos

Embedded VOs

XML_ATTRIBUTE_AD_Table_ID

public static final String XML_ATTRIBUTE_AD_Table_ID

Table ID Attribute

See Also:

Constant Field Values

XML_ATTRIBUTE_Record_ID

public static final String XML_ATTRIBUTE_Record_ID

Record ID Attribute

See Also:

Constant Field Values

Constructor Detail

VO

public VO(ArrayList<String> keys,
          ArrayList<String> values)

ArrayList Constructor

Parameters:

keys - keys

values - values

VO

public VO(Object[] keys,
          Object[] values)

Array Constructor

Parameters:

keys - keys

values - values

VO

public VO()

Empty Constructor

VO

public VO(String tableName,
          int table_ID,
          int record_ID)

Empty Constructor

VO

public VO(VO vo)

Copy Constructor

VO

public VO(Map<String,String> map)

Map Constructor

Parameters:

map - map

Method Detail

setHdrInfo

public void setHdrInfo(String tableName,
                       int table_ID,
                       int record_ID)

Set optional Header Info

Parameters:

tableName - table name

table_ID - table id

record_ID - record_id

size

public int size()

Get Size

Specified by:

size in interface Map<String,String>

Returns:

size

isEmpty

public boolean isEmpty()

Is Empty

Specified by:

isEmpty in interface Map<String,String>

Returns:

true if empty

containsKey

public boolean containsKey(Object key)

Contains Key

Specified by:

containsKey in interface Map<String,String>

Parameters:

key - key

Returns:

true if contains

containsValue

public boolean containsValue(Object value)

Contains Value

Specified by:

containsValue in interface Map<String,String>

Parameters:

value - value

Returns:

true if contains value

get

public String get(Object key)

Get Value as String of Key

Specified by:

get in interface Map<String,String>

Parameters:

key - key

Returns:

value or null

put

public String put(Object key,
                  Object value)

Put key/value

Parameters:

key - key

value - value

Returns:

previous value or null

put

public String put(String key,
                  String value)

Put key/value

Specified by:

put in interface Map<String,String>

Parameters:

key - key

value - value

Returns:

previous value or null

remove

public String remove(Object key)

Remove

Specified by:

remove in interface Map<String,String>

Parameters:

key - key

Returns:

previous value or null

putAll

public void putAll(Map<? extends String,? extends String> t)

Put All

Specified by:

putAll in interface Map<String,String>

Parameters:

t - map

clear

public void clear()

Clear keys/values

Specified by:

clear in interface Map<String,String>

keySet

public Set<String> keySet()

Get Key Set

Specified by:

keySet in interface Map<String,String>

Returns:

key set

values

public Collection<String> values()

Get Values

Specified by:

values in interface Map<String,String>

Returns:

values as collection

entrySet

public Set<Map.Entry<String,String>> entrySet()

Get Values Set

Specified by:

entrySet in interface Map<String,String>

Returns:

values set

getHashMap

public HashMap<String,String> getHashMap()

Get VO as HashMap

Returns:

hash map

clone

public VO clone()

Clone object

Overrides:

clone in class Object

Returns:

clone

getData

public String[] getData(String[] columns)

Get Data as Array positioned by column

Parameters:

columns - array of Columns

Returns:

array of data

setEmbedded

public void setEmbedded(ArrayList<VO> vos)

Set Embedded

Parameters:

vos - array list of VOs

getEmbedded

public ArrayList<VO> getEmbedded()

Get Embedded VOs

Returns:

array list of VOs or null

toString

public String toString()

String Representation

Overrides:

toString in class Object

Returns:

info

toStringX

public String toStringX()

Extended Info

dump

public void dump()

Dump Attributes to out

get_xmlString

public StringBuffer get_xmlString(StringBuffer xml)

Get Object xml (data only) representation as string

Parameters:

xml - optional string buffer

Returns:

updated/new string buffer header is only added once

get_xmlString

public StringBuffer get_xmlString(StringBuffer xml,
                                  boolean dataOnly)

Get Object xml representation as string

Parameters:

xml - optional string buffer

dataOnly - if false, add value, label and info tags

Returns:

updated/new string buffer header is only added once

get_xmlDocument

public Document get_xmlDocument(boolean noComment,
                                boolean dataOnly)

Get XML Document representation

Parameters:

noComment - do not add comment

dataOnly - if false, add value, label and info tags

Returns:

XML document