|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.hydrateframework.gen.schema.SchemaElementBase org.hydrateframework.gen.schema.Relationship.Reference
public class Relationship.Reference
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.hydrateframework.gen.schema.Member |
---|
Member.CollectionType, Member.SpecialColumnType |
Nested classes/interfaces inherited from interface org.hydrateframework.gen.schema.SchemaElement |
---|
SchemaElement.HighlightType |
Field Summary | |
---|---|
protected ClassDef |
classDef
|
protected java.lang.String |
comment
|
protected boolean |
isCollection
|
protected int |
isNavigable
|
protected boolean |
isOptional
|
protected java.lang.String |
javaVarName
|
protected java.lang.String |
multiplicity
|
protected java.lang.String |
name
|
protected java.lang.String |
toObject
|
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, log, NAME, valid |
Fields inherited from interface org.hydrateframework.gen.schema.Member |
---|
INUSE_CLASSDIAGRAM, INUSE_IMPLEMENT, INUSE_INTERFACE, INUSE_NEXT, INUSE_XMLSCHEMA |
Constructor Summary | |
---|---|
Relationship.Reference()
|
|
Relationship.Reference(Relationship.Reference override)
|
Method Summary | |
---|---|
Member.CollectionType |
collectionType()
The type of collection |
boolean |
equals(java.lang.Object o)
|
Member[] |
explode()
|
Member[] |
explode(boolean collection)
|
ClassDef |
getClassDef()
|
Type |
getCollectionOf()
The type of collection |
java.lang.String |
getComment()
A comment that describes the purpose of this member e.g. |
SchemaElement.HighlightType |
getHighlightType()
|
java.lang.String |
getJavaAttrName()
The java name of the attribute. |
java.lang.String |
getJavaEmptyValue()
The string that is the default value for this member in java |
java.lang.String |
getJavaNativeType()
True if this member's type is a java native type |
java.lang.String |
getJavaNotPopulatedValue()
The java constant that indicates that the member is 'not populated' |
java.lang.String |
getJavaNotSetValue()
The java constant that indicates that the member is 'not set'. |
java.lang.String |
getJavaPublicType()
The name of the type as presented in the external interface. |
java.lang.String |
getJavaSqlType()
|
java.lang.String |
getJavaStaticName()
The name of the static variable associated with this field in java. |
java.lang.String |
getJavaTypeName()
The name of the type in Java. |
java.lang.String |
getJavaVarName()
The java name of the member. |
int |
getLength()
Return the length of the member. |
java.lang.String |
getMultiplicity()
|
java.lang.String |
getName()
The name of the member. |
Relationship.Reference |
getOpposingReference()
|
SchemaElementBase |
getOverrides()
|
int |
getPrecision()
Return the precision of the member. |
ClassDef |
getReferencedClassDef()
|
Key |
getReferencedKey()
|
ClassDef |
getReferencingClassDef()
|
Relationship |
getRelationship()
|
int |
getScale()
Return the precision of the member. |
Member.SpecialColumnType |
getSpecialColumnType()
True if this is an invisible field (such as an automatically generated primary key) |
java.lang.String |
getSQLTypeName(SQLWriter sqlWriter)
|
java.lang.String |
getTypeName()
The type name of the member. |
java.lang.String |
getXSDTypeName()
|
boolean |
hasDiscriminator()
|
boolean |
isEnumeration()
|
boolean |
isInUse(int inContext)
true if this member is currently important to the dataset being used |
boolean |
isNavigable()
Only valid if isReference is true. |
boolean |
isOptional()
True if this is an optional member (may take the not set value) |
boolean |
isOwned()
True if this member is owned, or has is lifecycle encapsulated by the referencing object |
boolean |
isPersistent()
False if this is a transient field that is never stored in the database |
boolean |
isReference()
True if this member is a reference to another hydrate object |
boolean |
isSupressedLink()
true if this is a suppressed link that is not to be stored in the database |
boolean |
isToManyRef()
Only valid if isReference is true. |
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 |
resolve()
|
void |
setMultiplicity(java.lang.String mult)
|
void |
setName(java.lang.String nm)
|
void |
setNavigable(boolean b)
|
void |
setOwned(boolean b)
|
void |
setReferencedClassDef(ClassDef def)
|
void |
setReferencedKey(Key key)
|
boolean |
shouldWrite()
|
protected void |
suppressLink()
|
java.lang.String |
toString()
|
java.lang.String |
toSummary()
|
java.lang.String |
writeAsString(java.lang.String obj)
|
java.lang.String |
writeCompareTwo(java.lang.String one,
java.lang.String two)
|
java.lang.String |
writeCvtFromJavaObj(java.lang.String obj)
|
java.lang.String |
writeCvtInternalToPublic(java.lang.String var)
Write code that will convert the internal representation of a variable into the public representation. |
java.lang.String |
writeCvtPublicToInternal(java.lang.String var)
Write code that will convert the public representation of a variable into the internal representation. |
java.lang.String |
writeFromString(java.lang.String obj)
|
java.lang.String |
writeHashCode(java.lang.String var)
|
java.lang.String |
writeJavaKeyField(java.lang.String varName)
|
java.lang.String |
writeJavaSqlRead(java.lang.String rs,
java.lang.String mbrIdx)
|
java.lang.String |
writeJavaSqlSet(java.lang.String stmt,
java.lang.String mbrIdx,
java.lang.String mbrVar)
|
java.lang.String |
writeJavaSqlUpdate(java.lang.String rs,
java.lang.String mbrIdx,
java.lang.String mbrVar)
|
void |
writeToXmlDoc(SAXWriter wrt)
Write out this schema element to the SAX Handler |
java.lang.String |
writeUpdFromUnderlying(java.lang.String var)
|
void |
writeXSDType(SAXWriter wrt)
|
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, wait, wait, wait |
Field Detail |
---|
protected java.lang.String name
protected java.lang.String javaVarName
protected java.lang.String comment
protected java.lang.String toObject
protected java.lang.String multiplicity
protected int isNavigable
protected boolean isOptional
protected boolean isCollection
protected ClassDef classDef
Constructor Detail |
---|
public Relationship.Reference()
public Relationship.Reference(Relationship.Reference override)
Method Detail |
---|
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public SchemaElementBase getOverrides()
getOverrides
in class SchemaElementBase
public java.lang.String toSummary()
toSummary
in interface SchemaElement
public void resolve()
resolve
in interface SchemaElement
public ClassDef getClassDef()
public Relationship getRelationship()
public Key getReferencedKey()
public void setReferencedKey(Key key)
public void setMultiplicity(java.lang.String mult)
public java.lang.String getName()
Member
getName
in interface Member
getName
in interface SchemaElement
public java.lang.String getJavaVarName()
Member
getJavaVarName
in interface Member
public java.lang.String toString()
toString
in class java.lang.Object
public void setName(java.lang.String nm)
public ClassDef getReferencedClassDef()
public void setReferencedClassDef(ClassDef def)
public java.lang.String getMultiplicity()
protected void suppressLink()
public int getLength()
Member
getLength
in interface Member
public int getPrecision()
Member
getPrecision
in interface Member
public int getScale()
Member
getScale
in interface Member
public boolean isOwned()
Member
isOwned
in interface Member
public void setOwned(boolean b)
public ClassDef getReferencingClassDef()
getReferencingClassDef
in interface Member
public java.lang.String getJavaTypeName()
Member
getJavaTypeName
in interface Member
public java.lang.String getJavaPublicType()
Member
getJavaPublicType
in interface Member
public java.lang.String getJavaStaticName()
Member
getJavaStaticName
in interface Member
public java.lang.String getJavaNotSetValue()
Member
getJavaNotSetValue
in interface Member
public java.lang.String getJavaNotPopulatedValue()
Member
getJavaNotPopulatedValue
in interface Member
public java.lang.String getJavaAttrName()
Member
getJavaAttrName
in interface Member
public java.lang.String getComment()
Member
getComment
in interface Member
public boolean isOptional()
Member
isOptional
in interface Member
public boolean isSupressedLink()
Member
isSupressedLink
in interface Member
public boolean isReference()
Member
isReference
in interface Member
public boolean isInUse(int inContext)
Member
isInUse
in interface Member
public boolean isNavigable()
Member
isNavigable
in interface Member
public void setNavigable(boolean b)
public boolean isToManyRef()
Member
isToManyRef
in interface Member
public Member.CollectionType collectionType()
Member
collectionType
in interface Member
public Type getCollectionOf()
Member
getCollectionOf
in interface Member
public java.lang.String getJavaNativeType()
Member
getJavaNativeType
in interface Member
public java.lang.String getJavaEmptyValue()
Member
getJavaEmptyValue
in interface Member
public Member.SpecialColumnType getSpecialColumnType()
Member
getSpecialColumnType
in interface Member
public Relationship.Reference getOpposingReference()
public java.lang.String getJavaSqlType()
getJavaSqlType
in interface Member
public java.lang.String writeJavaSqlUpdate(java.lang.String rs, java.lang.String mbrIdx, java.lang.String mbrVar)
writeJavaSqlUpdate
in interface Member
public java.lang.String writeJavaSqlRead(java.lang.String rs, java.lang.String mbrIdx)
writeJavaSqlRead
in interface Member
public java.lang.String writeCvtFromJavaObj(java.lang.String obj)
writeCvtFromJavaObj
in interface Member
public java.lang.String writeCvtInternalToPublic(java.lang.String var)
Member
writeCvtInternalToPublic
in interface Member
public java.lang.String writeCvtPublicToInternal(java.lang.String var)
Member
writeCvtPublicToInternal
in interface Member
public boolean isPersistent()
Member
isPersistent
in interface Member
public java.lang.String getTypeName()
Member
getTypeName
in interface Member
public Member[] explode()
explode
in interface Member
public boolean hasDiscriminator()
public Member[] explode(boolean collection)
public java.lang.String writeAsString(java.lang.String obj)
writeAsString
in interface Member
public java.lang.String writeFromString(java.lang.String obj)
writeFromString
in interface Member
public java.lang.String writeJavaKeyField(java.lang.String varName)
writeJavaKeyField
in interface Member
public java.lang.String getSQLTypeName(SQLWriter sqlWriter)
getSQLTypeName
in interface Member
public java.lang.String writeJavaSqlSet(java.lang.String stmt, java.lang.String mbrIdx, java.lang.String mbrVar)
writeJavaSqlSet
in interface Member
public java.lang.String writeHashCode(java.lang.String var)
writeHashCode
in interface Member
public java.lang.String writeUpdFromUnderlying(java.lang.String var)
writeUpdFromUnderlying
in interface Member
public java.lang.String getXSDTypeName()
getXSDTypeName
in interface Member
public void writeXSDType(SAXWriter wrt) throws org.xml.sax.SAXException
writeXSDType
in interface Member
org.xml.sax.SAXException
public java.lang.String writeCompareTwo(java.lang.String one, java.lang.String two)
writeCompareTwo
in interface Member
public boolean isValid(java.lang.StringBuffer reason)
SchemaElement
isValid
in interface SchemaElement
reason
- the reason for the failure (or warning) if any should be appended to this string buffer.
public void notifyUpdate(SchemaElement element)
SchemaElement
notifyUpdate
in interface SchemaElement
element
- the overridden schema element.public SchemaElement override(Family family)
SchemaElement
SchemaElement.notifyUpdate(SchemaElement)
method when this element changes.
override
in interface SchemaElement
family
- the family in which the overridden element is to be created
public boolean readFromXmlDoc(java.util.Stack<java.lang.String> readContext, org.w3c.dom.Element elem)
SchemaElement
readFromXmlDoc
in interface SchemaElement
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.public boolean shouldWrite()
shouldWrite
in interface SchemaElement
public void writeToXmlDoc(SAXWriter wrt) throws org.xml.sax.SAXException
SchemaElement
writeToXmlDoc
in interface SchemaElement
org.xml.sax.SAXException
public SchemaElement.HighlightType getHighlightType()
getHighlightType
in interface SchemaElement
public boolean isEnumeration()
isEnumeration
in interface Member
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |