oracle.jbo.service.helper
Class SDOViewBuilderSrcImpl

java.lang.Object
  oracle.jbo.service.helper.SDOViewBuilderSrcImpl

All Implemented Interfaces:

SDOAnnotationProvider, SDOBuilderSrc

Direct Known Subclasses:

PDefSDOViewBuilderSrcImpl

public abstract class SDOViewBuilderSrcImpl
extends java.lang.Object
implements SDOBuilderSrc, SDOAnnotationProvider

Since:

11.1.1.1.0

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.jbo.service.helper.SDOBuilderSrc

SDOBuilderSrc.MimeTypeProperty

Nested classes/interfaces inherited from interface oracle.jbo.service.helper.SDOAnnotationProvider

SDOAnnotationProvider.Category

Field Summary

protected commonj.sdo.helper.HelperContext	mHelperContext
protected ViewDefImpl	mView
protected ViewLinkDefImpl	mViewLink

Constructor Summary

SDOViewBuilderSrcImpl(ViewDefImpl view)

SDOViewBuilderSrcImpl(ViewDefImpl view, commonj.sdo.helper.HelperContext helperContext)

SDOViewBuilderSrcImpl(ViewLinkDefImpl viewLink)

SDOViewBuilderSrcImpl(ViewLinkDefImpl viewLink, commonj.sdo.helper.HelperContext helperContext)

Method Summary

protected AttributeDef	findAttributeDef(java.lang.String attrName)
java.lang.String	getAttributeDescription(java.lang.String attrName) Gets the description of the SDO attribute.
java.util.List<java.lang.String>	getAttributeNames() Gets the list of child attribute names contained in the SDO.
java.util.List<java.lang.String>	getCategoryValues(SDOAnnotationProvider.Category category) Gets the list of category values assigned to the SDO.
java.lang.Object	getDefault() Gets the default value for this source.
java.lang.String	getDescription() Gets the description of the SDO.
java.lang.String	getDisplayName() Gets the external (display) name of the SDO.
java.util.List<java.lang.String[]>	getDocumentation() Gets the list of documentation (and their resource locations) for the SDO.
java.lang.String	getJavaTypeName() Gets the sdoJava:instanceClass annotation for this source.
java.util.List<java.lang.String>	getKeyPropertyNames() Gets the names of the properties that represent the Key for this source.
java.util.List<java.lang.String>	getKeywords() Gets the keywords for the SDO.
SDOBuilderSrc.MimeTypeProperty	getMimeTypeProperty() Gets the mime type for this source.
java.util.List<java.lang.String[]>	getRelationships() Gets the list of relationships (name and type) from the SDO.
commonj.sdo.Type	getSDOType() Gets the SDO Type for this source.
protected commonj.sdo.Type	getSDOType(ViewDefImpl viewDef)
commonj.sdo.Type	getXMLDataTypeProperty() Gets the sdoXML:dataType annotation for this source.
java.lang.String	getXMLName() Gets the name property for this source.
java.lang.String	getXMLNamespace() Gets the uri property for this source.
java.lang.String	getXMLTypeName() Gets the name of the type for this source.
boolean	isMany() Returns true if instances of this property is many-valued.
boolean	isNullable() Returns true if instances of this property can be set to null.
boolean	isSimpleType() Returns true if this source specifies a data type and false if this source specifies a DataObject.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.jbo.service.helper.SDOBuilderSrc

getBaseTypes, getProperties, getSchemaLocation

Field Detail

mViewLink

protected ViewLinkDefImpl mViewLink

mView

protected ViewDefImpl mView

mHelperContext

protected commonj.sdo.helper.HelperContext mHelperContext

Constructor Detail

SDOViewBuilderSrcImpl

public SDOViewBuilderSrcImpl(ViewDefImpl view)

SDOViewBuilderSrcImpl

public SDOViewBuilderSrcImpl(ViewDefImpl view,
                             commonj.sdo.helper.HelperContext helperContext)

SDOViewBuilderSrcImpl

public SDOViewBuilderSrcImpl(ViewLinkDefImpl viewLink)

SDOViewBuilderSrcImpl

public SDOViewBuilderSrcImpl(ViewLinkDefImpl viewLink,
                             commonj.sdo.helper.HelperContext helperContext)

Method Detail

getDefault

public java.lang.Object getDefault()

Description copied from interface: SDOBuilderSrc

Gets the default value for this source.

Only applicable to simple types.

Specified by:

getDefault in interface SDOBuilderSrc

Returns:

the default value for this source.

getJavaTypeName

public java.lang.String getJavaTypeName()

Description copied from interface: SDOBuilderSrc

Gets the sdoJava:instanceClass annotation for this source.

Specified by:

getJavaTypeName in interface SDOBuilderSrc

Returns:

the full class name used to implement the SDO Type.

getKeyPropertyNames

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

Description copied from interface: SDOBuilderSrc

Gets the names of the properties that represent the Key for this source.

Only applicable to complex types.

Specified by:

getKeyPropertyNames in interface SDOBuilderSrc

Returns:

the list of Key properties.

getMimeTypeProperty

public SDOBuilderSrc.MimeTypeProperty getMimeTypeProperty()

Description copied from interface: SDOBuilderSrc

Gets the mime type for this source. The mime type value can be either a constant mime type or the name of another property on the same container data object from which to get the mime type value.

Only applicable to simple types.

Specified by:

getMimeTypeProperty in interface SDOBuilderSrc

Returns:

the mime type for this source.

getSDOType

public commonj.sdo.Type getSDOType()

Description copied from interface: SDOBuilderSrc

Gets the SDO Type for this source.

Only applicable to simple types.

Specified by:

getSDOType in interface SDOBuilderSrc

Returns:

the SDO Type for this source.

getXMLDataTypeProperty

public commonj.sdo.Type getXMLDataTypeProperty()

Description copied from interface: SDOBuilderSrc

Gets the sdoXML:dataType annotation for this source. This is used to override the default Java type mapping during SDO class generation.

Specified by:

getXMLDataTypeProperty in interface SDOBuilderSrc

Returns:

the SDO Type for XSD Types as a means to override the instance class.

getXMLName

public java.lang.String getXMLName()

Description copied from interface: SDOBuilderSrc

Gets the name property for this source.

Specified by:

getXMLName in interface SDOBuilderSrc

Returns:

name for this source.

getXMLNamespace

public java.lang.String getXMLNamespace()

Description copied from interface: SDOBuilderSrc

Gets the uri property for this source.

Specified by:

getXMLNamespace in interface SDOBuilderSrc

Returns:

uri for this source.

getXMLTypeName

public java.lang.String getXMLTypeName()

Description copied from interface: SDOBuilderSrc

Gets the name of the type for this source.

Specified by:

getXMLTypeName in interface SDOBuilderSrc

Returns:

name of the SDO Type.

isMany

public boolean isMany()

Description copied from interface: SDOBuilderSrc

Returns true if instances of this property is many-valued.

Specified by:

isMany in interface SDOBuilderSrc

Returns:

whether the property is many-valued.

isNullable

public boolean isNullable()

Description copied from interface: SDOBuilderSrc

Returns true if instances of this property can be set to null.

Specified by:

isNullable in interface SDOBuilderSrc

Returns:

whether the property can be set to null.

isSimpleType

public boolean isSimpleType()

Description copied from interface: SDOBuilderSrc

Returns true if this source specifies a data type and false if this source specifies a DataObject.

Specified by:

isSimpleType in interface SDOBuilderSrc

Returns:

whether the SDO Type is a data type.

getSDOType

protected commonj.sdo.Type getSDOType(ViewDefImpl viewDef)

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: SDOAnnotationProvider

Gets the external (display) name of the SDO.

Specified by:

getDisplayName in interface SDOAnnotationProvider

Returns:

name of the SDO.

getDescription

public java.lang.String getDescription()

Description copied from interface: SDOAnnotationProvider

Gets the description of the SDO.

Specified by:

getDescription in interface SDOAnnotationProvider

Returns:

description of the SDO.

getKeywords

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

Description copied from interface: SDOAnnotationProvider

Gets the keywords for the SDO.

Specified by:

getKeywords in interface SDOAnnotationProvider

Returns:

keywords for the SDO.

getCategoryValues

public java.util.List<java.lang.String> getCategoryValues(SDOAnnotationProvider.Category category)

Description copied from interface: SDOAnnotationProvider

Gets the list of category values assigned to the SDO.

Specified by:

getCategoryValues in interface SDOAnnotationProvider

Parameters:

category - category for the SDO

Returns:

list of category values assigned to the SDO.

getDocumentation

public java.util.List<java.lang.String[]> getDocumentation()

Description copied from interface: SDOAnnotationProvider

Gets the list of documentation (and their resource locations) for the SDO.

Specified by:

getDocumentation in interface SDOAnnotationProvider

Returns:

links to documentation relevant for the SDO.

getRelationships

public java.util.List<java.lang.String[]> getRelationships()

Description copied from interface: SDOAnnotationProvider

Gets the list of relationships (name and type) from the SDO.

Specified by:

getRelationships in interface SDOAnnotationProvider

Returns:

list of relationships from the SDO.

getAttributeNames

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

Description copied from interface: SDOAnnotationProvider

Gets the list of child attribute names contained in the SDO.

Specified by:

getAttributeNames in interface SDOAnnotationProvider

Returns:

the list of attribute names for the SDO.

getAttributeDescription

public java.lang.String getAttributeDescription(java.lang.String attrName)

Description copied from interface: SDOAnnotationProvider

Gets the description of the SDO attribute.

Specified by:

getAttributeDescription in interface SDOAnnotationProvider

Parameters:

attrName - name of the SDO attribute

Returns:

description of the SDO attribute.

findAttributeDef

protected AttributeDef findAttributeDef(java.lang.String attrName)