org.hydrateframework.gen.schema
Class Relationship

java.lang.Object
  extended by org.hydrateframework.gen.schema.SchemaElementBase
      extended by org.hydrateframework.gen.schema.Relationship
All Implemented Interfaces:
SchemaElement
Direct Known Subclasses:
Relationship

public class Relationship
extends SchemaElementBase

Version:
@(#)$Revision: 1.8 $
Author:
David Chamberlin

Nested Class Summary
 class Relationship.NestedMember
           
 class Relationship.Reference
           
 
Nested classes/interfaces inherited from interface org.hydrateframework.gen.schema.SchemaElement
SchemaElement.HighlightType
 
Field Summary
protected  java.lang.String comment
           
protected  Family family
           
protected  java.lang.String name
           
protected  Relationship.Reference[] references
           
 
Fields inherited from class org.hydrateframework.gen.schema.SchemaElementBase
ATTR_MANDATORY, ATTR_MANDATORYNOOVR, ATTR_NOOVR, ATTR_OPTIONAL, ATTR_OPTIONALNOOVR, BOOL_FALSE, BOOL_NOT, BOOL_NOTSET, BOOL_TRUE, NAME, valid
 
Constructor Summary
Relationship(Family family)
           
Relationship(Family family, Relationship override)
           
 
Method Summary
 boolean equals(java.lang.Object o)
           
 java.lang.String getComment()
           
 Relationship.Reference getFirstReference()
           
 SchemaElement.HighlightType getHighlightType()
           
 java.lang.String getName()
           
 SchemaElementBase getOverrides()
           
 Relationship.Reference getSecondReference()
           
 java.lang.String getTablespace()
           
 boolean isValid(java.lang.StringBuffer reason)
          Determine if the schema element just read is valid.
 void notifyUpdate(SchemaElement element)
          Notify a schema element that the schema element it is overriding has changed
 SchemaElement override(Family family)
          Override the schema element from ain included file.
 boolean readFromXmlDoc(java.util.Stack<java.lang.String> readContext, org.w3c.dom.Element elem)
          Read the element from the DOM model
 void remove()
           
 void resolve()
           
 void setOverridden(Relationship override)
           
 boolean shouldWrite()
           
 java.lang.String toSummary()
           
 void writeToXmlDoc(SAXWriter wrt)
          Notify the contentHandler of the state of this class
 
Methods inherited from class org.hydrateframework.gen.schema.SchemaElementBase
addBoolAttribute, addEnumAttribute, addIntAttribute, addListAttribute, addStringAttribute, isValidIdentifier, newElement, printAttrWarning, printWarning, readBoolAttribute, readEnumAttribute, readIntAttribute, readListAttribute, readStringAttribute, refEquals, supersedes
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

references

protected Relationship.Reference[] references

name

protected java.lang.String name

comment

protected java.lang.String comment

family

protected Family family
Constructor Detail

Relationship

public Relationship(Family family)

Relationship

public Relationship(Family family,
                    Relationship override)
Method Detail

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

getOverrides

public SchemaElementBase getOverrides()
Specified by:
getOverrides in class SchemaElementBase

toSummary

public java.lang.String toSummary()

setOverridden

public void setOverridden(Relationship override)

getFirstReference

public Relationship.Reference getFirstReference()

getSecondReference

public Relationship.Reference getSecondReference()

resolve

public void resolve()

remove

public void remove()

isValid

public boolean isValid(java.lang.StringBuffer reason)
Description copied from interface: SchemaElement
Determine if the schema element just read is valid.

Parameters:
reason - the reason for the failure (or warning) if any should be appended to this string buffer.
Returns:
true if the element is valid, false otherwise.

getName

public java.lang.String getName()

getComment

public java.lang.String getComment()

getTablespace

public java.lang.String getTablespace()

writeToXmlDoc

public void writeToXmlDoc(SAXWriter wrt)
                   throws org.xml.sax.SAXException
Notify the contentHandler of the state of this class

Parameters:
contentHandler - the content handler to notify of events.
Throws:
org.xml.sax.SAXException

readFromXmlDoc

public boolean readFromXmlDoc(java.util.Stack<java.lang.String> readContext,
                              org.w3c.dom.Element elem)
Description copied from interface: SchemaElement
Read the element from the DOM model

Parameters:
readContext - the context within the XML of the read operation. This is used to help pinpoint the source of an error.
elem - the DOM element to use to initialize this class.

notifyUpdate

public void notifyUpdate(SchemaElement element)
Description copied from interface: SchemaElement
Notify a schema element that the schema element it is overriding has changed

Parameters:
element - the overridden schema element.

override

public SchemaElement override(Family family)
Description copied from interface: SchemaElement
Override the schema element from ain included file. The implementation of this method should make a new SchemaElement, that knows that it is overriding this element. It should also remember the identity of the schema element that has overridden it (i.e. the element it returns so that it can notify it via the SchemaElement.notifyUpdate(SchemaElement) method when this element changes.

Parameters:
family - the family in which the overridden element is to be created
Returns:
the new schema element that overrides this one.

shouldWrite

public boolean shouldWrite()

getHighlightType

public SchemaElement.HighlightType getHighlightType()


Copyright © 2000 The Hydrate Project. All Rights Reserved.