oracle.jbo.service.helper

Interface SDOBuilderSrc

All Known Implementing Classes:

PDefSDOViewBuilderSrcImpl, SDOViewAttrBuilderSrcImpl, SDOViewBuilderSrcImpl

public interface SDOBuilderSrc

Since:

release specific (what release of product did this appear in)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SDOBuilderSrc.MimeTypeProperty

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<commonj.sdo.Type,java.net.URL>	getBaseTypes() Gets the list of base types (and their schema locations) for this source.
java.lang.Object	getDefault() Gets the default value for this source.
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.
SDOBuilderSrc.MimeTypeProperty	getMimeTypeProperty() Gets the mime type for this source.
java.util.List<SDOBuilderSrc>	getProperties() Gets the list of child properties contained in this source.
java.net.URL	getSchemaLocation() Gets the schema location for this source, e.g.
commonj.sdo.Type	getSDOType() Gets the SDO Type for this source.
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.

Method Detail

getBaseTypes

java.util.Map<commonj.sdo.Type,java.net.URL> getBaseTypes()

Gets the list of base types (and their schema locations) for this source. Return an empty map if there are no base types.

Returns:

the list of base types for this source.

getDefault

java.lang.Object getDefault()

Gets the default value for this source.

Only applicable to simple types.

Returns:

the default value for this source.

getJavaTypeName

java.lang.String getJavaTypeName()

Gets the sdoJava:instanceClass annotation for this source.

Returns:

the full class name used to implement the SDO Type.

getKeyPropertyNames

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

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

Only applicable to complex types.

Returns:

the list of Key properties.

getMimeTypeProperty

SDOBuilderSrc.MimeTypeProperty getMimeTypeProperty()

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.

Returns:

the mime type for this source.

getProperties

java.util.List<SDOBuilderSrc> getProperties()

Gets the list of child properties contained in this source. Return an empty list if there are no children.

Returns:

the list of properties for this source.

getSchemaLocation

java.net.URL getSchemaLocation()

Gets the schema location for this source, e.g. file:/META-INF/wsdl/model/User.xsd. This URL is used for schema location resolution.

Returns:

the schema location for this source.

getSDOType

commonj.sdo.Type getSDOType()

Gets the SDO Type for this source.

Only applicable to simple types.

Returns:

the SDO Type for this source.

getXMLDataTypeProperty

commonj.sdo.Type getXMLDataTypeProperty()

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

Returns:

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

getXMLName

java.lang.String getXMLName()

Gets the name property for this source.

Returns:

name for this source.

getXMLNamespace

java.lang.String getXMLNamespace()

Gets the uri property for this source.

Returns:

uri for this source.

getXMLTypeName

java.lang.String getXMLTypeName()

Gets the name of the type for this source.

Returns:

name of the SDO Type.

isMany

boolean isMany()

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

Returns:

whether the property is many-valued.

isNullable

boolean isNullable()

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

Returns:

whether the property can be set to null.

isSimpleType

boolean isSimpleType()

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

Returns:

whether the SDO Type is a data type.