org.hydrateframework.gen.schema
Interface Member

All Superinterfaces:

SchemaElement

All Known Subinterfaces:

Member

All Known Implementing Classes:

Attribute, Attribute, DefaultKeyAttribute, DiscriminatorAttribute, Relationship.NestedMember, Relationship.Reference, Relationship.Reference

public interface Member
extends SchemaElement

Version:

@(#)$Revision: 1.6 $

Author:

David Chamberlin

Nested Class Summary

static class	Member.CollectionType
static class	Member.SpecialColumnType

Nested classes/interfaces inherited from interface org.hydrateframework.gen.schema.SchemaElement

SchemaElement.HighlightType

Field Summary

static int	INUSE_CLASSDIAGRAM
static int	INUSE_IMPLEMENT
static int	INUSE_INTERFACE
static int	INUSE_NEXT
static int	INUSE_XMLSCHEMA Create an instance of a member class that overrides this member.

Method Summary

Member.CollectionType	collectionType() The type of collection
Member[]	explode()
Type	getCollectionOf() The type of collection
java.lang.String	getComment() A comment that describes the purpose of this member e.g.
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	getName() The name of the member.
int	getPrecision() Return the precision of the member.
ClassDef	getReferencingClassDef()
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	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.
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)
java.lang.String	writeUpdFromUnderlying(java.lang.String var)
void	writeXSDType(SAXWriter wrt)

Methods inherited from interface org.hydrateframework.gen.schema.SchemaElement

getHighlightType, isValid, notifyUpdate, override, readFromXmlDoc, resolve, shouldWrite, toSummary, writeToXmlDoc

Field Detail

INUSE_XMLSCHEMA

static final int INUSE_XMLSCHEMA

Create an instance of a member class that overrides this member. This is used with definition files that include other definition files.

See Also:

Constant Field Values

INUSE_CLASSDIAGRAM

static final int INUSE_CLASSDIAGRAM

See Also:

Constant Field Values

INUSE_INTERFACE

static final int INUSE_INTERFACE

See Also:

Constant Field Values

INUSE_IMPLEMENT

static final int INUSE_IMPLEMENT

See Also:

Constant Field Values

INUSE_NEXT

static final int INUSE_NEXT

See Also:

Constant Field Values

Method Detail

getReferencingClassDef

ClassDef getReferencingClassDef()

getName

java.lang.String getName()

The name of the member. This is normally in camel case e.g. dateOfBirth

Specified by:

getName in interface SchemaElement

getJavaVarName

java.lang.String getJavaVarName()

The java name of the member.

getTypeName

java.lang.String getTypeName()

The type name of the member. This is language independent

getJavaTypeName

java.lang.String getJavaTypeName()

The name of the type in Java. e.g. java.util.Date

getSQLTypeName

java.lang.String getSQLTypeName(SQLWriter sqlWriter)

getJavaPublicType

java.lang.String getJavaPublicType()

The name of the type as presented in the external interface. This may be different from the type as stored in the object.

getJavaStaticName

java.lang.String getJavaStaticName()

The name of the static variable associated with this field in java. e.g. DATEOFBIRTH

getJavaNotSetValue

java.lang.String getJavaNotSetValue()

The java constant that indicates that the member is 'not set'. e.g. null

getJavaNotPopulatedValue

java.lang.String getJavaNotPopulatedValue()

The java constant that indicates that the member is 'not populated'

getJavaAttrName

java.lang.String getJavaAttrName()

The java name of the attribute. This is normally in mixed case e.g. DateOfBirth

getComment

java.lang.String getComment()

A comment that describes the purpose of this member e.g. The date on which the individual was born

getLength

int getLength()

Return the length of the member. e.g. the string length or total memory size of a number

getPrecision

int getPrecision()

Return the precision of the member. e.g. the number of decimal digits of a number

getScale

int getScale()

Return the precision of the member. e.g. the number of decimal places of a number

isOptional

boolean isOptional()

True if this is an optional member (may take the not set value)

isOwned

boolean isOwned()

True if this member is owned, or has is lifecycle encapsulated by the referencing object

isReference

boolean isReference()

True if this member is a reference to another hydrate object

isNavigable

boolean isNavigable()

Only valid if isReference is true. Indicates that there is a get/set method for this reference

isToManyRef

boolean isToManyRef()

Only valid if isReference is true. Indicates that the reference is a collection

collectionType

Member.CollectionType collectionType()

The type of collection

getCollectionOf

Type getCollectionOf()

The type of collection

getJavaNativeType

java.lang.String getJavaNativeType()

True if this member's type is a java native type

getJavaEmptyValue

java.lang.String getJavaEmptyValue()

The string that is the default value for this member in java

getSpecialColumnType

Member.SpecialColumnType getSpecialColumnType()

True if this is an invisible field (such as an automatically generated primary key)

isPersistent

boolean isPersistent()

False if this is a transient field that is never stored in the database

isSupressedLink

boolean isSupressedLink()

true if this is a suppressed link that is not to be stored in the database

isInUse

boolean isInUse(int inContext)

true if this member is currently important to the dataset being used

getJavaSqlType

java.lang.String getJavaSqlType()

writeJavaSqlUpdate

java.lang.String writeJavaSqlUpdate(java.lang.String rs,
                                    java.lang.String mbrIdx,
                                    java.lang.String mbrVar)

writeJavaSqlSet

java.lang.String writeJavaSqlSet(java.lang.String stmt,
                                 java.lang.String mbrIdx,
                                 java.lang.String mbrVar)

writeJavaSqlRead

java.lang.String writeJavaSqlRead(java.lang.String rs,
                                  java.lang.String mbrIdx)

writeCvtFromJavaObj

java.lang.String writeCvtFromJavaObj(java.lang.String obj)

writeAsString

java.lang.String writeAsString(java.lang.String obj)

writeFromString

java.lang.String writeFromString(java.lang.String obj)

writeJavaKeyField

java.lang.String writeJavaKeyField(java.lang.String varName)

writeHashCode

java.lang.String writeHashCode(java.lang.String var)

writeUpdFromUnderlying

java.lang.String writeUpdFromUnderlying(java.lang.String var)

writeCvtInternalToPublic

java.lang.String writeCvtInternalToPublic(java.lang.String var)

Write code that will convert the internal representation of a variable into the public representation.

writeCvtPublicToInternal

java.lang.String writeCvtPublicToInternal(java.lang.String var)

Write code that will convert the public representation of a variable into the internal representation.

explode

Member[] explode()

getXSDTypeName

java.lang.String getXSDTypeName()

writeXSDType

void writeXSDType(SAXWriter wrt)
                  throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

writeCompareTwo

java.lang.String writeCompareTwo(java.lang.String one,
                                 java.lang.String two)

isEnumeration

boolean isEnumeration()