Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> dods >> [ data overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of dods.data.DataObject JAVADOC | Sourc code of dods.data.DataObject SOURCE | Download dods.data.DataObject DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

dods.data
Class DataObject  view DataObject download DataObject.java

java.lang.Object
  extended bydods.data.DataObject
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
DOPackage
public class DataObject
extends java.lang.Object
implements java.io.Serializable

A holder for all the information describing a Data Object.

Version:
$Revision: 1.10 $

Field Summary
protected  boolean Abstract
          This is true if the DataObject is abstract.
static java.lang.String ALL_CLASSES
          Valid dbTableType where all classes get a table.
protected  java.util.Vector ancestors
          All of the DataObjects that this DataObject inherits from.
protected  java.util.Vector attributes
          All of the Attributes that this Data Object has.
protected  boolean caching
          True if this Class will implement a cache.
static java.lang.String CONCRETE
          Valid dbTableType where all concrete classes get a table.
protected  java.lang.String dbTableName
          Name of the dbTable that this Object will go into.
protected  java.lang.String dbTableType
          Type of mapping this Object will use to go into the Database
protected  java.util.Vector descendents
          All of the DataObjects which have this DataObject as an ancestor.
static java.lang.String ENTIRE_HIERARCHY
          Valid dbTableType where an entire hierarchy is mapped to one table.
protected  java.util.Vector extendedBy
          All of the DataObjects which extend this one.
protected  DataObject extensionOf
          The DataObject that this DataObject extends.
protected  boolean Final
          True if this Class will be final.
protected  boolean fullCaching
          True if this Class will fully cache all objects from the database.
protected  boolean index
          True when this DataObject is an index for the dataBase.
protected  boolean lazyLoading
          True if this Class will use "lazy loading" where the DO values are retrieved from the DB only when on the first get or set call.
protected  java.lang.String name
          The name of this DataObject.
protected  java.lang.String packageName
          Name of the Package this class will be in.
 
Constructor Summary
DataObject()
          Constructor which initializes all of the variables to default values.
DataObject(java.lang.String s)
          Constructor which initializes everything to default values except name.
 
Method Summary
 void addAttribute(Attribute att)
          Adds a new Attribute.
static java.util.Vector alphabetizeVector(java.util.Vector DOS)
          This method will take in a vector of DataObjects and Strings and stick all of the strings at the front and alphabetize the DataObjects.
 boolean checkIdentifier(java.lang.String s)
          Returns true if the string is a valid identifier.
 boolean checkPackageIdentifier(java.lang.String s)
          Similar to checkIdentifier, but this will not give an error when "." are found in the string.
 boolean equals(DataObject doa)
          Determines if two DataObjects are equal by comparing each value in them.
 java.lang.String getAdjustedPackageName()
           
 java.util.Vector getAncestors()
           
 java.util.Vector getAttributes()
           
 java.lang.String getDBTableName()
           
 java.lang.String getDBTableType()
           
 java.util.Vector getDescendents()
           
 java.util.Vector getExtendedBy()
           
 DataObject getExtensionOf()
           
 java.lang.String getName()
           
 java.lang.String getPackageName()
           
 boolean hasAttributeErrors()
          This method checks to see if any of the Attributes in this DataObject have errors.
 boolean isAbstract()
           
 boolean isCaching()
           
 boolean isConcrete()
           
 boolean isFinal()
           
 boolean isFullCaching()
           
 boolean isIndex()
           
 boolean isLazyLoading()
           
 boolean isLeaf()
           
 void setAbstract(boolean abstract1)
          Sets if this is an abstract Class.
 void setAttributes(java.util.Vector atts)
          Sets the attributes to the new vector of attributes.
 void setCaching(boolean impl_cache)
          Sets caching for this DataObject
 void setDBTableName(java.lang.String dbtablename)
          Sets up the name of the Table that this DataObject will be in.
 void setDBTableType(java.lang.String dbtabletype)
          Sets the DBTableType to a new valid value.
 void setExtensionOf(DataObject extensionof)
          Sets the DataObject that this extends to a new DataObject
 void setFinal(boolean Fina)
          Sets Final for this DataObject
 void setFullCaching(boolean full)
          Sets lazyLoading for this DataObject
 void setIndex(boolean Index)
          Sets if this is an index or not.
 void setLazyLoading(boolean lazy)
          Sets lazyLoading for this DataObject
 void setName(java.lang.String s)
          Sets the name for this DataObject if it is a valid className.
 void setPackageName(java.lang.String packagename)
          Set's the name of the Package for this DataObject.
 java.lang.String toString()
          Returns a String representation of the form: "packageName.nameDO"
 void updateAncestors()
          This method reworks the hierarchy of DataObjects when a relationship between them is changed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

dbTableType

protected java.lang.String dbTableType
Type of mapping this Object will use to go into the Database

attributes

protected java.util.Vector attributes
All of the Attributes that this Data Object has.

packageName

protected java.lang.String packageName
Name of the Package this class will be in.

ancestors

protected java.util.Vector ancestors
All of the DataObjects that this DataObject inherits from.

Abstract

protected boolean Abstract
This is true if the DataObject is abstract.

extendedBy

protected java.util.Vector extendedBy
All of the DataObjects which extend this one.

dbTableName

protected java.lang.String dbTableName
Name of the dbTable that this Object will go into.

index

protected boolean index
True when this DataObject is an index for the dataBase.

name

protected java.lang.String name
The name of this DataObject. This also defines the future class name which will be nameDO.class

descendents

protected java.util.Vector descendents
All of the DataObjects which have this DataObject as an ancestor.

Final

protected boolean Final
True if this Class will be final.

lazyLoading

protected boolean lazyLoading
True if this Class will use "lazy loading" where the DO values are retrieved from the DB only when on the first get or set call.

fullCaching

protected boolean fullCaching
True if this Class will fully cache all objects from the database.

caching

protected boolean caching
True if this Class will implement a cache.

extensionOf

protected DataObject extensionOf
The DataObject that this DataObject extends.

CONCRETE

public static final java.lang.String CONCRETE
Valid dbTableType where all concrete classes get a table.

See Also:
Constant Field Values

ALL_CLASSES

public static final java.lang.String ALL_CLASSES
Valid dbTableType where all classes get a table.

See Also:
Constant Field Values

ENTIRE_HIERARCHY

public static final java.lang.String ENTIRE_HIERARCHY
Valid dbTableType where an entire hierarchy is mapped to one table.

See Also:
Constant Field Values
Constructor Detail

DataObject

public DataObject(java.lang.String s)
Constructor which initializes everything to default values except name.

DataObject

public DataObject()
Constructor which initializes all of the variables to default values.

Method Detail

setName

public void setName(java.lang.String s)
             throws com.lutris.dods.exceptions.DataObjectNameException
Sets the name for this DataObject if it is a valid className.

getName

public java.lang.String getName()

setDBTableName

public void setDBTableName(java.lang.String dbtablename)
                    throws com.lutris.dods.exceptions.DataObjectNameException
Sets up the name of the Table that this DataObject will be in.

getDBTableName

public java.lang.String getDBTableName()

setPackageName

public void setPackageName(java.lang.String packagename)
                    throws com.lutris.dods.exceptions.DataObjectNameException
Set's the name of the Package for this DataObject.

getPackageName

public java.lang.String getPackageName()

getAdjustedPackageName

public java.lang.String getAdjustedPackageName()

setFinal

public void setFinal(boolean Fina)
Sets Final for this DataObject

isFinal

public boolean isFinal()

setLazyLoading

public void setLazyLoading(boolean lazy)
Sets lazyLoading for this DataObject

isLazyLoading

public boolean isLazyLoading()

setFullCaching

public void setFullCaching(boolean full)
Sets lazyLoading for this DataObject

isFullCaching

public boolean isFullCaching()

setCaching

public void setCaching(boolean impl_cache)
Sets caching for this DataObject

isCaching

public boolean isCaching()

setExtensionOf

public void setExtensionOf(DataObject extensionof)
Sets the DataObject that this extends to a new DataObject

getExtensionOf

public DataObject getExtensionOf()

getExtendedBy

public java.util.Vector getExtendedBy()

getDescendents

public java.util.Vector getDescendents()

getAttributes

public java.util.Vector getAttributes()

setAttributes

public void setAttributes(java.util.Vector atts)
Sets the attributes to the new vector of attributes.

addAttribute

public void addAttribute(Attribute att)
Adds a new Attribute.

setIndex

public void setIndex(boolean Index)
Sets if this is an index or not.

isIndex

public boolean isIndex()

setAbstract

public void setAbstract(boolean abstract1)
Sets if this is an abstract Class.

isConcrete

public boolean isConcrete()

isLeaf

public boolean isLeaf()

isAbstract

public boolean isAbstract()

setDBTableType

public void setDBTableType(java.lang.String dbtabletype)
                    throws com.lutris.dods.exceptions.DataObjectTypeException
Sets the DBTableType to a new valid value.

getDBTableType

public java.lang.String getDBTableType()

getAncestors

public java.util.Vector getAncestors()

equals

public boolean equals(DataObject doa)
Determines if two DataObjects are equal by comparing each value in them.

toString

public java.lang.String toString()
Returns a String representation of the form: "packageName.nameDO"

checkIdentifier

public boolean checkIdentifier(java.lang.String s)
Returns true if the string is a valid identifier.

checkPackageIdentifier

public boolean checkPackageIdentifier(java.lang.String s)
Similar to checkIdentifier, but this will not give an error when "." are found in the string.

updateAncestors

public void updateAncestors()
This method reworks the hierarchy of DataObjects when a relationship between them is changed.

hasAttributeErrors

public boolean hasAttributeErrors()
This method checks to see if any of the Attributes in this DataObject have errors.

alphabetizeVector

public static java.util.Vector alphabetizeVector(java.util.Vector DOS)
This method will take in a vector of DataObjects and Strings and stick all of the strings at the front and alphabetize the DataObjects.

Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> dods >> [ data overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of dods.data.DataObject JAVADOC | Sourc code of dods.data.DataObject SOURCE | Download dods.data.DataObject DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD