org.openbandy.example.bos
Class Car

java.lang.Object
  extended by org.openbandy.example.bos.Car
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
Sportscar

public class Car
extends java.lang.Object
implements Serializable

An example business object that shows how to implement the Serializable interface. This class contains attributes as well as a vector of serializable objects.

(c) Copyright P. Bolliger 2007, ALL RIGHTS RESERVED.

Version:
1.0
Author:
Philipp Bolliger (philipp@bolliger.name)

Constructor Summary
Car()
           
 
Method Summary
 void addTire(Tire tire)
           
 void deserialize(Serializer serializer, SerializationBuffer serializationBuffer)
          This method must overwrite the attributes denoted in getAttributeNames() with values read from the container provided.
 void getAttributeNames(java.util.Vector attributes)
          This method must put the name of every attribute that needs to be serialized in the given Vector.
 java.lang.String getBrand()
           
 Serializable getCopy()
          Must return a copy of the object that is equal according to the method isEuqalTo().
 Engine getEngine()
           
 java.lang.String getIdName()
          Must return the name of the id (e.g.
 int getIdValue()
          Must return the value of the id.
 java.lang.String getLegibleString()
          Must return a human readable String representation of the object.
 int getLength()
           
 Serializable getNewInstance()
          Must return a new and initialized instance.
 void getReferencedIdNames(java.util.Vector referenceNames)
          This method must put every id name of referenced objects, i.e.
 void getReferences(java.util.Vector references)
          This method must put every reference to Serializable objects, i.e.
 SerializableVector getTires()
           
 boolean isEqual(Serializable serializableObject)
          Must return true if the serializableObject is equal to this, except for the id but INCLUDING equality of referenced serializables.
 boolean isEqualShallow(Serializable serializableObject)
          Must return true if the serializableObject is equal to this, except for the id, EXCLUDING equality of referenced serializables.
 void serialize(Serializer serializer, SerializationBuffer serializationBuffer)
          This method must fill the container provided with the serialization- Object with values for every attribute denoted in getAttributeNames().
 void setBrand(java.lang.String brand)
           
 void setEngine(Engine engine)
           
 void setIdValue(int idValue)
          Set the id to the given value.
 void setLength(int length)
           
 void setTires(SerializableVector tires)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Car

public Car()
Method Detail

getBrand

public java.lang.String getBrand()

setBrand

public void setBrand(java.lang.String brand)

getLength

public int getLength()

setLength

public void setLength(int length)

getEngine

public Engine getEngine()

setEngine

public void setEngine(Engine engine)

getTires

public SerializableVector getTires()

setTires

public void setTires(SerializableVector tires)

addTire

public void addTire(Tire tire)

serialize

public void serialize(Serializer serializer,
                      SerializationBuffer serializationBuffer)
Description copied from interface: Serializable
This method must fill the container provided with the serialization- Object with values for every attribute denoted in getAttributeNames(). Subsequently it must serialize member objects as denoted in getReferences().

Specified by:
serialize in interface Serializable
Parameters:
serializer - - the serializer used for call-backs
serializationBuffer - - the serializationBuffer containing the container to write values to

deserialize

public void deserialize(Serializer serializer,
                        SerializationBuffer serializationBuffer)
Description copied from interface: Serializable
This method must overwrite the attributes denoted in getAttributeNames() with values read from the container provided. Subsequently it must de- serialize member objects as denoted in getReferences().

Specified by:
deserialize in interface Serializable
Parameters:
serializer - - the serializer used for call-backs
serializationBuffer - - the buffer to read values from

getIdName

public java.lang.String getIdName()
Description copied from interface: Serializable
Must return the name of the id (e.g. eventId).

Specified by:
getIdName in interface Serializable
Returns:
the name of the id

getIdValue

public int getIdValue()
Description copied from interface: Serializable
Must return the value of the id.

Specified by:
getIdValue in interface Serializable
Returns:
the actual value of id

setIdValue

public void setIdValue(int idValue)
Description copied from interface: Serializable
Set the id to the given value.

Specified by:
setIdValue in interface Serializable
Parameters:
idValue - - the new id value

getAttributeNames

public void getAttributeNames(java.util.Vector attributes)
Description copied from interface: Serializable
This method must put the name of every attribute that needs to be serialized in the given Vector. For every String value contained in attributes, there must be a corresponding field in the database for example.

Specified by:
getAttributeNames in interface Serializable
Parameters:
attributes - - the vector to be filled

getReferences

public void getReferences(java.util.Vector references)
Description copied from interface: Serializable
This method must put every reference to Serializable objects, i.e. member objects, in the given Vector.

Specified by:
getReferences in interface Serializable
Parameters:
references - - the vector to be filled

getReferencedIdNames

public void getReferencedIdNames(java.util.Vector referenceNames)
Description copied from interface: Serializable
This method must put every id name of referenced objects, i.e. member objects that need to be serialized, in the given Vector.

Specified by:
getReferencedIdNames in interface Serializable
Parameters:
referenceNames - - the vector to be filled

getLegibleString

public java.lang.String getLegibleString()
Description copied from interface: Serializable
Must return a human readable String representation of the object.

Specified by:
getLegibleString in interface Serializable
Returns:
human legible string

isEqualShallow

public boolean isEqualShallow(Serializable serializableObject)
                       throws java.lang.ClassCastException
Description copied from interface: Serializable
Must return true if the serializableObject is equal to this, except for the id, EXCLUDING equality of referenced serializables.

Specified by:
isEqualShallow in interface Serializable
Parameters:
serializableObject - - the object to compare
Returns:
true if serializableObject is equal to this
Throws:
java.lang.ClassCastException

isEqual

public boolean isEqual(Serializable serializableObject)
                throws java.lang.ClassCastException
Description copied from interface: Serializable
Must return true if the serializableObject is equal to this, except for the id but INCLUDING equality of referenced serializables.

Specified by:
isEqual in interface Serializable
Parameters:
serializableObject - - the object to compare
Returns:
true if serializableObject is equal to this
Throws:
java.lang.ClassCastException

getCopy

public Serializable getCopy()
Description copied from interface: Serializable
Must return a copy of the object that is equal according to the method isEuqalTo().

Specified by:
getCopy in interface Serializable
Returns:
copy of this

getNewInstance

public Serializable getNewInstance()
Description copied from interface: Serializable
Must return a new and initialized instance.

Specified by:
getNewInstance in interface Serializable
Returns:
New instance of concrete class.