net.sf.xtvdclient.xtvd.datatypes
Class Lineup

java.lang.Object
  extended by net.sf.xtvdclient.xtvd.datatypes.AbstractDataType
      extended by net.sf.xtvdclient.xtvd.datatypes.Lineup
All Implemented Interfaces:
java.lang.Comparable

public class Lineup
extends AbstractDataType

A bean that represents a lineup record.


Field Summary
 
Fields inherited from class net.sf.xtvdclient.xtvd.datatypes.AbstractDataType
END_OF_LINE
 
Constructor Summary
Lineup()
          Default constructor.
Lineup(java.lang.String id, java.lang.String name, java.lang.String location, LineupTypes type)
          Create a new instance of the class with the specified values of name and type.
Lineup(java.lang.String id, java.lang.String name, java.lang.String location, LineupTypes type, java.lang.String device, java.lang.String postalCode)
          Create a new instance of the class, and initiliase the instance variables with the specified values.
Lineup(java.lang.String id, java.lang.String name, java.lang.String location, LineupTypes type, java.lang.String device, java.lang.String postalCode, java.util.Collection<Map> map)
          Create a new instance of the class, and initiliase the instance variables with the specified values.
 
Method Summary
 void addMap(Map map)
          Add the specified instance of Map to the maps collection.
 java.lang.String getDevice()
          Returns device.
 java.lang.String getId()
          Returns id.
 java.lang.String getLocation()
          Returns location.
 java.util.Collection<Map> getMaps()
          Returns maps.
 java.lang.String getName()
          Returns name.
 java.lang.String getPostalCode()
          Returns postalCode.
 LineupTypes getType()
          Returns type.
 void reset()
          Reset all the instance variables to empty values.
 void setDevice(java.lang.String device)
          Set device.
 void setId(java.lang.String id)
          Set id.
 void setLocation(java.lang.String location)
          Set location.
 void setMaps(java.util.Collection<Map> maps)
          Set maps.
 void setName(java.lang.String name)
          Set name.
 void setPostalCode(java.lang.String postalCode)
          Set postalCode.
 void setType(LineupTypes type)
          Set type.
 java.lang.String toString()
          Over-ridden implementation.
 
Methods inherited from class net.sf.xtvdclient.xtvd.datatypes.AbstractDataType
compareTo, equals, replaceSpecialCharacters, replaceSpecialCharacters
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Lineup

public Lineup()
Default constructor. Not particularly useful, except if you wish to create an instance of the class, that will be re-used to associate with different lineup records.


Lineup

public Lineup(java.lang.String id,
              java.lang.String name,
              java.lang.String location,
              LineupTypes type)
Create a new instance of the class with the specified values of name and type.

Parameters:
id - The id value to set.
name - The name value to set.
location - The location value to set.
type - The type value to set.
Since:
ddclient version 1.3

Lineup

public Lineup(java.lang.String id,
              java.lang.String name,
              java.lang.String location,
              LineupTypes type,
              java.lang.String device,
              java.lang.String postalCode)
Create a new instance of the class, and initiliase the instance variables with the specified values.

Parameters:
id - The id value to set.
name - The name value to set.
location - The location value to set.
type - The type value to set.
device - The device value to set.
postalCode - The postalCode value to set.
Since:
ddclient version 1.3

Lineup

public Lineup(java.lang.String id,
              java.lang.String name,
              java.lang.String location,
              LineupTypes type,
              java.lang.String device,
              java.lang.String postalCode,
              java.util.Collection<Map> map)
Create a new instance of the class, and initiliase the instance variables with the specified values.

Parameters:
id - The id value to set.
name - The name value to set.
location - The location value to set.
type - The type value to set.
device - The device value to set.
postalCode - The postalCode value to set.
map - The maps reference to set.
Since:
ddclient version 1.3
Method Detail

reset

public void reset()
Reset all the instance variables to empty values.


toString

public java.lang.String toString()
Over-ridden implementation. Return an XML representation of the class fields in the same format as in the original XTVD document.

Overrides:
toString in class java.lang.Object
Returns:
The XML representation of the lineup record.

getId

public final java.lang.String getId()
Returns id.

Returns:
The value/reference of/to id.

setId

public final void setId(java.lang.String id)
Set id.

Parameters:
id - The value to set.

getName

public final java.lang.String getName()
Returns name.

Returns:
The value/reference of/to name.

setName

public final void setName(java.lang.String name)
Set name.

Parameters:
name - The value to set.

getLocation

public final java.lang.String getLocation()
Returns location.

Returns:
The value/reference of/to location.

setLocation

public final void setLocation(java.lang.String location)
Set location.

Parameters:
location - The value to set.

getType

public final LineupTypes getType()
Returns type.

Returns:
The value/reference of/to type.

setType

public final void setType(LineupTypes type)
Set type.

Parameters:
type - The value to set.

getDevice

public final java.lang.String getDevice()
Returns device.

Returns:
The value/reference of/to device.

setDevice

public final void setDevice(java.lang.String device)
Set device.

Parameters:
device - The value to set.

getPostalCode

public final java.lang.String getPostalCode()
Returns postalCode.

Returns:
The value/reference of/to postalCode.

setPostalCode

public final void setPostalCode(java.lang.String postalCode)
Set postalCode.

Parameters:
postalCode - The value to set.

getMaps

public final java.util.Collection<Map> getMaps()
Returns maps.

Returns:
The value/reference of/to map.

setMaps

public final void setMaps(java.util.Collection<Map> maps)
Set maps.

Parameters:
maps - The value to set.

addMap

public final void addMap(Map map)
Add the specified instance of Map to the maps collection.

Parameters:
map - The map that is to be added to the collection.