ptdb.common.dto

Class XMLDBModel

java.lang.Object

ptdb.common.dto.XMLDBModel

All Implemented Interfaces:

java.lang.Comparable

public class XMLDBModel
extends java.lang.Object
implements java.lang.Comparable

The Model that need to be stored or retrieved from the database.

It is used as a data transfer object and hold 4 information about the model:
- Model name.
- Model content in xml format.
- Does the model exist in the database or it is a new model.
- List of parents for the current model.
Each of the 4 information has its own getter and setter methods.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Yousef Alsaeed

Pt.AcceptedRating:

Red (yalsaeed)

Pt.ProposedRating:

Red (yalsaeed)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DB_MODEL_ID_ATTR String for DBModelId.
static java.lang.String	DB_MODEL_NAME String for model name.
static java.lang.String	DB_REFERENCE_ATTR String for DBReference.

Constructor Summary

Constructors

Constructor and Description
XMLDBModel(java.lang.String modelName) Construct a XMLDBModel instance with the given model name.
XMLDBModel(java.lang.String modelName, java.lang.String modelId) Construct a XMLDBModel instance with the given model name.

Method Summary

Modifier and Type	Method and Description
void	addParentList(java.util.List<XMLDBModel> list) Add the given parent list to the model's parent list.
void	addReferencedChild(java.lang.String modelId) Add the given child entity to the model's referenced children list.
int	compareTo(java.lang.Object otherModel) Compare this model with another given model, and the model is compared according to their name.
boolean	equals(java.lang.Object xmldbModel) Return true if this XMLDBModel has the same name as the argument.
boolean	getIsNew() Return True or false based on if the model is new or it exists in the database.
java.lang.String	getModel() Return the model content.
java.lang.String	getModelId() Return the model id.
java.lang.String	getModelName() Return the model name.
java.util.List<java.util.List<XMLDBModel>>	getParents() Return the parents for the current model.
int	getReferenceCount(java.util.List<XMLDBModel> list) Return the number of times the model is referenced in the given hierarchy.
java.util.List<java.lang.String>	getReferencedChildren() Return the first level referenced children entities for the current model.
int	hashCode() Return the hash code for the XMLDBModel object.
void	setIsNew(boolean isNew) Set the isNew variable which indicates if the model is in the database or it is new model.
void	setModel(java.lang.String modelContent) Set the model content.
void	setModelId(java.lang.String modelId) Set the model identifier.
void	setModelName(java.lang.String modelName) Set the model name.
void	setParents(java.util.List<java.util.List<XMLDBModel>> listParents) Set the parents for the current model.
void	setReferencedChildren(java.util.List<java.lang.String> listChildren) Set the first level referenced children entities for the current model.
java.lang.String	toString() Get the String representation of this model.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DB_MODEL_ID_ATTR

public static final java.lang.String DB_MODEL_ID_ATTR

String for DBModelId.

See Also:

Constant Field Values

DB_REFERENCE_ATTR

public static final java.lang.String DB_REFERENCE_ATTR

String for DBReference.

See Also:

Constant Field Values

DB_MODEL_NAME

public static final java.lang.String DB_MODEL_NAME

String for model name.

See Also:

Constant Field Values

Constructor Detail

XMLDBModel

public XMLDBModel(java.lang.String modelName)

Construct a XMLDBModel instance with the given model name.

Parameters:

modelName - the name for the given model.

XMLDBModel

public XMLDBModel(java.lang.String modelName,
                  java.lang.String modelId)

Construct a XMLDBModel instance with the given model name.

Parameters:

modelName - Name for the given model.

modelId - Id for the given model.

Method Detail

addParentList

public void addParentList(java.util.List<XMLDBModel> list)

Add the given parent list to the model's parent list.

Parameters:

list - a List of parents to be added.

addReferencedChild

public void addReferencedChild(java.lang.String modelId)

Add the given child entity to the model's referenced children list.

Parameters:

modelId - Child entity to be added to the referenced children list.

compareTo

public int compareTo(java.lang.Object otherModel)

Compare this model with another given model, and the model is compared according to their name.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

otherModel - The other model to be compared with this model.

Returns:

The value to indicate the result of comparison. If the returned value is larger than 0, it means the otherModel is smaller. If the returned value is less than 0, it means the otherModel is larger. If 0 is returned, it means these two models are equal.

equals

public boolean equals(java.lang.Object xmldbModel)

Return true if this XMLDBModel has the same name as the argument.

Overrides:

equals in class java.lang.Object

Parameters:

xmldbModel - The XMLDBModel object to be compared.

Returns:

True if the two XMLDBModels have the same name.

hashCode

public int hashCode()

Return the hash code for the XMLDBModel object.

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code for this XMLDBModel object.

getIsNew

public boolean getIsNew()

Return True or false based on if the model is new or it exists in the database.

Returns:

True or false based on if the model is new or it exists in the database.

See Also:

setIsNew(boolean)

getModel

public java.lang.String getModel()

Return the model content.

Returns:

A string representation of the model content.

See Also:

setModel(java.lang.String)

getModelId

public java.lang.String getModelId()

Return the model id.

Returns:

The model id.

See Also:

setModelId(java.lang.String)

getModelName

public java.lang.String getModelName()

Return the model name.

Returns:

The model name.

See Also:

setModelName(java.lang.String)

getReferenceCount

public int getReferenceCount(java.util.List<XMLDBModel> list)

Return the number of times the model is referenced in the given hierarchy.

Parameters:

list - List of models in the parent hierarchy.

Returns:

the number of times the model is referenced in the given hierarchy.

getParents

public java.util.List<java.util.List<XMLDBModel>> getParents()

Return the parents for the current model.

Returns:

List of parents models for the current model.

See Also:

setParents(java.util.List<java.util.List<ptdb.common.dto.XMLDBModel>>)

getReferencedChildren

public java.util.List<java.lang.String> getReferencedChildren()

Return the first level referenced children entities for the current model.

Returns:

List of first level referenced children entities for the current model.

See Also:

setReferencedChildren(java.util.List<java.lang.String>)

setIsNew

public void setIsNew(boolean isNew)

Set the isNew variable which indicates if the model is in the database or it is new model.

Parameters:

isNew - a boolean True or false value to set the isNew member variable.

See Also:

getIsNew()

setModel

public void setModel(java.lang.String modelContent)

Set the model content.

Parameters:

modelContent - The model content in xml format.

See Also:

getModel()

setModelId

public void setModelId(java.lang.String modelId)

Set the model identifier.

Parameters:

modelId - The model identifier.

See Also:

getModelId()

setModelName

public void setModelName(java.lang.String modelName)

Set the model name.

Parameters:

modelName - The model name.

See Also:

getModelName()

setParents

public void setParents(java.util.List<java.util.List<XMLDBModel>> listParents)

Set the parents for the current model.

Parameters:

listParents - List of parents for this model.

See Also:

getParents()

setReferencedChildren

public void setReferencedChildren(java.util.List<java.lang.String> listChildren)

Set the first level referenced children entities for the current model.

Parameters:

listChildren - List of first level referenced children entities for this model.

See Also:

getReferencedChildren()

toString

public java.lang.String toString()

Get the String representation of this model.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this model.