moos.ssds.model
Class Deployment

java.lang.Object
  moos.ssds.model.DataProducer
      moos.ssds.model.Deployment

All Implemented Interfaces:

IDataProducer, IDateRange, IDeployment, IDescription, ResourceOwner, java.io.Serializable, ValueObject

public class Deployment

extends DataProducer

implements java.io.Serializable, IDeployment

The Monterey Bay Aquarium Research Institute (MBARI) provides this documentation and code "as is", with no warranty, express or implied, of its quality or consistency. It is provided without support and without obligation on the part of MBARI to assist in its use, correction, modification, or enhancement. This information should not be published or distributed to third parties without specific written permission from MBARI.

Copyright 2002 MBARI. MBARI Proprietary Information. All rights reserved.

Version:

: $Revision: 1.9 $

Author:

: $Author: kgomes $

See Also:

Serialized Form

Field Summary

Fields inherited from interface moos.ssds.model.IDeployment

INSTRUMENT_ROLE, OBSERVATORY_ROLE, PLATFORM_ROLE, SENSOR_ROLE

Constructor Summary

Deployment()
Constructor for the Deployment object

Deployment(IDevice device)
Constructor for the Deployment object

Deployment(IDevice d, IDeployment p)
Constructor that Rich says we need in order to keep the foreign key pointers synchonized between this Deployment, its parent and device.

Method Summary

void	addChildDeployment(IDeployment deployment) Adds a feature to the ChildDeployment attribute of the Deployment object
java.util.Collection	getChildDeployments() Gets the childDeployments attribute of the Deployment object
IDevice	getDevice() Gets the device attribute of the Deployment object
java.lang.Long	getDeviceId() Gets the deviceId attribute of the Deployment object
java.lang.Long	getMetadataId() Gets the metadataId attribute of the Deployment object
java.lang.Float	getNominalDepth()
java.lang.Double	getNominalLatitude()
java.lang.Double	getNominalLongitude()
java.lang.String	getOjbConcreteClass() Gets the ojbConcreteClass attribute of the Deployment object
IDeployment	getParentDeployment() Gets the parentDeployment attribute of the Deployment object
java.lang.Long	getParentId() Gets the parentId attribute of the Deployment object
java.lang.String	getRole() Gets the role attribute of the Deployment object
IX3DLocation	getX3DLocation() Gets the x3DLocation attribute of the Deployment object
java.util.Collection	listAllOutputsInclChildren()
java.util.Collection	listChildDeployments() List all child Deployments from this deployment
java.util.Collection	listChildDeployments(java.lang.String role) List child Deployments that have Role role from this deployment
java.util.Collection	listDerivedOutputsInclChildren() Lists outputs that were derived from outputs in this deployment, it's child deployments and any descendants Deployments (grand-children, great-grandchildren, etc)
java.util.Collection	listOutputsInclChildren() List outputs from this deployment, any contained child Deployments, and any descendants Deployments (grand-children, great grandchildren, etc)
void	removeChildDeployment(IDeployment deployment) Description of the Method
void	setChildDeployments(java.util.Collection children) Sets the childDeployments attribute of the Deployment object
void	setDevice(IDevice newDevice) Sets the device attribute of the Deployment object
void	setDeviceId(java.lang.Long device_id) Sets the deviceId attribute of the Deployment object
void	setMetadataId(java.lang.Long metadataId) Sets the metadataId attribute of the Deployment object
void	setNominalDepth(java.lang.Float nominalDepth)
void	setNominalLatitude(java.lang.Double nominalLatitude)
void	setNominalLongitude(java.lang.Double nominalLongitude)
void	setOjbConcreteClass(java.lang.String ojbConcreteClass) Sets the ojbConcreteClass attribute of the Deployment object
void	setParentDeployment(IDeployment parent)
void	setParentId(java.lang.Long parent_id) Sets the parentId attribute of the Deployment object
void	setRole(java.lang.String role) Sets the role attribute of the Deployment object
void	setX3DLocation(IX3DLocation x3DLocation) Sets the x3DLocation attribute of the Deployment object
java.lang.String	toString() Description of the Method

Methods inherited from class moos.ssds.model.DataProducer

addEvent, addInput, addOutput, addResource, getContact, getContactId, getDateRange, getDescription, getEndDate, getId, getName, getStartDate, listAllOutputs, listBestOutput, listDerivedOutputs, listEvents, listInputs, listOutputs, listResources, removeEvent, removeInput, removeOutput, removeResource, setContact, setContactId, setDescription, setEndDate, setId, setName, setStartDate

Methods inherited from class java.lang.Object

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

Methods inherited from interface moos.ssds.model.IDataProducer

addEvent, addInput, addOutput, addResource, getContact, getContactId, getDateRange, getDescription, getEndDate, getId, getName, getStartDate, listAllOutputs, listBestOutput, listDerivedOutputs, listEvents, listInputs, listOutputs, listResources, removeEvent, removeInput, removeOutput, removeResource, setContact, setContactId, setDescription, setEndDate, setId, setName, setStartDate

Constructor Detail

Deployment

public Deployment(IDevice device)

Constructor for the Deployment object

Parameters:

device - Description of the Parameter

Deployment

public Deployment(IDevice d,
                  IDeployment p)

Constructor that Rich says we need in order to keep the foreign key pointers synchonized between this Deployment, its parent and device.

Parameters:

d - Description of the Parameter

p - The parent deployment of this Deployment

Deployment

public Deployment()

Constructor for the Deployment object

Method Detail

addChildDeployment

public void addChildDeployment(IDeployment deployment)

Adds a feature to the ChildDeployment attribute of the Deployment object

Specified by:

addChildDeployment in interface IDeployment

Parameters:

deployment - The feature to be added to the ChildDeployment attribute

getChildDeployments

public java.util.Collection getChildDeployments()

Gets the childDeployments attribute of the Deployment object

Specified by:

getChildDeployments in interface IDeployment

Returns:

The childDeployments value

getDevice

public IDevice getDevice()

Gets the device attribute of the Deployment object

Specified by:

getDevice in interface IDeployment

Returns:

The device value

getDeviceId

public java.lang.Long getDeviceId()

Gets the deviceId attribute of the Deployment object

Specified by:

getDeviceId in interface IDeployment

Returns:

The deviceId value

getMetadataId

public java.lang.Long getMetadataId()

Gets the metadataId attribute of the Deployment object

Specified by:

getMetadataId in interface IDeployment

Returns:

The metadataId value

getOjbConcreteClass

public java.lang.String getOjbConcreteClass()

Gets the ojbConcreteClass attribute of the Deployment object

Specified by:

getOjbConcreteClass in interface IDeployment

Overrides:

getOjbConcreteClass in class DataProducer

Returns:

The ojbConcreteClass value

setParentDeployment

public void setParentDeployment(IDeployment parent)

Specified by:

setParentDeployment in interface IDeployment

getParentDeployment

public IDeployment getParentDeployment()

Gets the parentDeployment attribute of the Deployment object

Specified by:

getParentDeployment in interface IDeployment

Returns:

The parentDeployment value

getParentId

public java.lang.Long getParentId()

Gets the parentId attribute of the Deployment object

Specified by:

getParentId in interface IDeployment

Returns:

The parentId value

getRole

public java.lang.String getRole()

Gets the role attribute of the Deployment object

Specified by:

getRole in interface IDeployment

Returns:

The role value

getX3DLocation

public IX3DLocation getX3DLocation()

Gets the x3DLocation attribute of the Deployment object

Specified by:

getX3DLocation in interface IDeployment

Returns:

The x3DLocation value

listAllOutputsInclChildren

public java.util.Collection listAllOutputsInclChildren()

Specified by:

listAllOutputsInclChildren in interface IDeployment

Returns:

A Collection of DataContainers the includes the outputs of this Deployment and all Descendant Deployments (i.e Children, grandchildren, etc) as well as the derived products of this Deployment and its descendants.

listChildDeployments

public java.util.Collection listChildDeployments()

List all child Deployments from this deployment

Specified by:

listChildDeployments in interface IDeployment

Returns:

copy of all child Deployments

listChildDeployments

public java.util.Collection listChildDeployments(java.lang.String role)

List child Deployments that have Role role from this deployment

Specified by:

listChildDeployments in interface IDeployment

Parameters:

role - Description of the Parameter

Returns:

copy of child Deployments with role

listDerivedOutputsInclChildren

public java.util.Collection listDerivedOutputsInclChildren()

Lists outputs that were derived from outputs in this deployment, it's child deployments and any descendants Deployments (grand-children, great-grandchildren, etc)

Specified by:

listDerivedOutputsInclChildren in interface IDeployment

Returns:

A collection of DataContainers derived from the outputs of this deployment and its child deployments.

listOutputsInclChildren

public java.util.Collection listOutputsInclChildren()

List outputs from this deployment, any contained child Deployments, and any descendants Deployments (grand-children, great grandchildren, etc)

Specified by:

listOutputsInclChildren in interface IDeployment

Returns:

outputs from this deployment and any child Deployments

removeChildDeployment

public void removeChildDeployment(IDeployment deployment)

Description of the Method

Specified by:

removeChildDeployment in interface IDeployment

Parameters:

deployment - Description of the Parameter

setChildDeployments

public void setChildDeployments(java.util.Collection children)

Sets the childDeployments attribute of the Deployment object

Specified by:

setChildDeployments in interface IDeployment

Parameters:

children - The new childDeployments value

setDevice

public void setDevice(IDevice newDevice)

Sets the device attribute of the Deployment object

Specified by:

setDevice in interface IDeployment

Parameters:

newDevice - The new device value

setDeviceId

public void setDeviceId(java.lang.Long device_id)

Sets the deviceId attribute of the Deployment object

Specified by:

setDeviceId in interface IDeployment

Parameters:

device_id - The new deviceId value

setMetadataId

public void setMetadataId(java.lang.Long metadataId)

Sets the metadataId attribute of the Deployment object

Specified by:

setMetadataId in interface IDeployment

Parameters:

metadataId - The new metadataId value

setOjbConcreteClass

public void setOjbConcreteClass(java.lang.String ojbConcreteClass)

Sets the ojbConcreteClass attribute of the Deployment object

Specified by:

setOjbConcreteClass in interface IDeployment

Overrides:

setOjbConcreteClass in class DataProducer

Parameters:

ojbConcreteClass - The new ojbConcreteClass value

setParentId

public void setParentId(java.lang.Long parent_id)

Sets the parentId attribute of the Deployment object

Specified by:

setParentId in interface IDeployment

Parameters:

parent_id - The new parentId value

setRole

public void setRole(java.lang.String role)

Sets the role attribute of the Deployment object

Specified by:

setRole in interface IDeployment

Parameters:

role - The new role value

setX3DLocation

public void setX3DLocation(IX3DLocation x3DLocation)

Sets the x3DLocation attribute of the Deployment object

Specified by:

setX3DLocation in interface IDeployment

Parameters:

x3DLocation - The new x3DLocation value

toString

public java.lang.String toString()

Description of the Method

Specified by:

toString in interface IDeployment

Returns:

Description of the Return Value

getNominalLatitude

public java.lang.Double getNominalLatitude()

Specified by:

getNominalLatitude in interface IDeployment

setNominalLatitude

public void setNominalLatitude(java.lang.Double nominalLatitude)

Specified by:

setNominalLatitude in interface IDeployment

getNominalLongitude

public java.lang.Double getNominalLongitude()

Specified by:

getNominalLongitude in interface IDeployment

setNominalLongitude

public void setNominalLongitude(java.lang.Double nominalLongitude)

Specified by:

setNominalLongitude in interface IDeployment

getNominalDepth

public java.lang.Float getNominalDepth()

Specified by:

getNominalDepth in interface IDeployment

setNominalDepth

public void setNominalDepth(java.lang.Float nominalDepth)

Specified by:

setNominalDepth in interface IDeployment