diff --git a/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml b/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml index bcfcb06fa8..368aff401f 100644 --- a/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml +++ b/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml @@ -1,6 +1,7 @@ - - + + SDO_DAS_ChangeSummary::beginLogging diff --git a/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml b/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml index 575c4a624f..0a98512c0b 100644 --- a/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml +++ b/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml @@ -1,6 +1,7 @@ - - + + SDO_DAS_ChangeSummary::endLogging diff --git a/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml b/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml index b281f4e451..879f95b9d4 100644 --- a/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml +++ b/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml @@ -1,6 +1,7 @@ - - + + SDO_DAS_ChangeSummary::getChangeType diff --git a/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml b/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml index cdac0c8a0f..f773f5d71a 100644 --- a/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml +++ b/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml @@ -1,6 +1,7 @@ - - + + SDO_DAS_ChangeSummary::getChangedDataObjects diff --git a/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml b/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml index 699667ce15..6c7b07055a 100644 --- a/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml +++ b/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml @@ -1,6 +1,7 @@ - - + + SDO_DAS_ChangeSummary::getOldContainer diff --git a/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml b/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml index 2868b62827..c6577b19d4 100644 --- a/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml +++ b/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml @@ -1,6 +1,7 @@ - - + + SDO_DAS_ChangeSummary::getOldValues diff --git a/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml b/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml index bc77ad2096..6ca8225290 100644 --- a/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml +++ b/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml @@ -1,6 +1,7 @@ - - + + SDO_DAS_ChangeSummary::isLogging diff --git a/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml b/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml index 4ec86165a5..09e0e5c76b 100644 --- a/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml +++ b/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml @@ -1,6 +1,7 @@ - - + + SDO_DAS_DataFactory::addPropertyToType diff --git a/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml b/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml index 608567c77b..2c77819749 100644 --- a/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml +++ b/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml @@ -1,6 +1,7 @@ - - + + SDO_DAS_DataFactory::addType diff --git a/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml b/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml index 1ffac49a3e..f8cc00e7c2 100644 --- a/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml +++ b/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml @@ -1,6 +1,7 @@ - - + + SDO_DAS_DataFactory::getDataFactory diff --git a/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml b/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml index c8aa3ca1fd..851902fbb5 100644 --- a/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml +++ b/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml @@ -1,6 +1,7 @@ - - + + SDO_DAS_DataObject::getChangeSummary diff --git a/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml b/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml index 88e5dfe583..6b131e6b6a 100644 --- a/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml +++ b/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml @@ -1,6 +1,7 @@ - - + + SDO_DAS_Setting::getListIndex diff --git a/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml b/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml index 2b7825ae1d..724350baea 100644 --- a/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml +++ b/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml @@ -1,6 +1,7 @@ - - + + SDO_DAS_Setting::getPropertyIndex diff --git a/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml b/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml index 70c84e2c5d..22a291c3f5 100644 --- a/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml +++ b/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml @@ -1,6 +1,7 @@ - - + + SDO_DAS_Setting::getPropertyName diff --git a/reference/sdo/functions/SDO-DAS-Setting-getValue.xml b/reference/sdo/functions/SDO-DAS-Setting-getValue.xml index 6d54f2ce9f..7893be146e 100644 --- a/reference/sdo/functions/SDO-DAS-Setting-getValue.xml +++ b/reference/sdo/functions/SDO-DAS-Setting-getValue.xml @@ -1,6 +1,7 @@ - - + + SDO_DAS_Setting::getValue diff --git a/reference/sdo/functions/SDO-DAS-Setting-isSet.xml b/reference/sdo/functions/SDO-DAS-Setting-isSet.xml index 60a138fed7..c4bb48af47 100644 --- a/reference/sdo/functions/SDO-DAS-Setting-isSet.xml +++ b/reference/sdo/functions/SDO-DAS-Setting-isSet.xml @@ -1,6 +1,7 @@ - - + + SDO_DAS_Setting::isSet diff --git a/reference/sdo/functions/SDO-DataFactory-create.xml b/reference/sdo/functions/SDO-DataFactory-create.xml index 9b71ee2f4a..53ba8109b1 100644 --- a/reference/sdo/functions/SDO-DataFactory-create.xml +++ b/reference/sdo/functions/SDO-DataFactory-create.xml @@ -1,6 +1,7 @@ - - + + SDO_DataFactory::create diff --git a/reference/sdo/functions/SDO-DataObject-clear.xml b/reference/sdo/functions/SDO-DataObject-clear.xml index 24c06fb684..2fe6872352 100644 --- a/reference/sdo/functions/SDO-DataObject-clear.xml +++ b/reference/sdo/functions/SDO-DataObject-clear.xml @@ -1,6 +1,7 @@ - - + + SDO_DataObject::clear diff --git a/reference/sdo/functions/SDO-DataObject-createDataObject.xml b/reference/sdo/functions/SDO-DataObject-createDataObject.xml index db03539f49..7726d21848 100644 --- a/reference/sdo/functions/SDO-DataObject-createDataObject.xml +++ b/reference/sdo/functions/SDO-DataObject-createDataObject.xml @@ -1,6 +1,7 @@ - - + + SDO_DataObject::createDataObject diff --git a/reference/sdo/functions/SDO-DataObject-getContainer.xml b/reference/sdo/functions/SDO-DataObject-getContainer.xml index 149f40c687..f050998f66 100644 --- a/reference/sdo/functions/SDO-DataObject-getContainer.xml +++ b/reference/sdo/functions/SDO-DataObject-getContainer.xml @@ -1,6 +1,7 @@ - - + + SDO_DataObject::getContainer diff --git a/reference/sdo/functions/SDO-DataObject-getSequence.xml b/reference/sdo/functions/SDO-DataObject-getSequence.xml index 92e1469ad3..8367cf7b51 100644 --- a/reference/sdo/functions/SDO-DataObject-getSequence.xml +++ b/reference/sdo/functions/SDO-DataObject-getSequence.xml @@ -1,6 +1,7 @@ - - + + SDO_DataObject::getSequence diff --git a/reference/sdo/functions/SDO-List-insert.xml b/reference/sdo/functions/SDO-List-insert.xml index e7ef8323fa..aa133634eb 100644 --- a/reference/sdo/functions/SDO-List-insert.xml +++ b/reference/sdo/functions/SDO-List-insert.xml @@ -1,6 +1,7 @@ - - + + SDO_List::insert diff --git a/reference/sdo/functions/SDO-Model-Property-getContainingType.xml b/reference/sdo/functions/SDO-Model-Property-getContainingType.xml new file mode 100644 index 0000000000..faa13cbca0 --- /dev/null +++ b/reference/sdo/functions/SDO-Model-Property-getContainingType.xml @@ -0,0 +1,139 @@ + + + + + + SDO_Model_Property::getContainingType + Get the SDO_Model_Type which contains this property. + + + &reftitle.description; + + SDO_Model_Type + SDO_Model_Property::getContainingType + + + + &warn.experimental.func; + + + Returns the SDO_Model_Type which contains this property. + + + + + &reftitle.parameters; + + None. + + + + &reftitle.returnvalues; + + Returns the SDO_Model_Type which contains this property. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-Property-getDefault.xml b/reference/sdo/functions/SDO-Model-Property-getDefault.xml new file mode 100644 index 0000000000..42da7b699a --- /dev/null +++ b/reference/sdo/functions/SDO-Model-Property-getDefault.xml @@ -0,0 +1,140 @@ + + + + + + SDO_Model_Property::getDefault + Get the default value for the property + + + &reftitle.description; + + mixed + SDO_Model_Property::getDefault + + + + &warn.experimental.func; + + + Returns the default value for the property. + Only primitive data type properties can have default values. + + + + + &reftitle.parameters; + + None. + + + + &reftitle.returnvalues; + + Returns the default value for the property. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-Property-getName.xml b/reference/sdo/functions/SDO-Model-Property-getName.xml new file mode 100644 index 0000000000..6a78f78ee2 --- /dev/null +++ b/reference/sdo/functions/SDO-Model-Property-getName.xml @@ -0,0 +1,139 @@ + + + + + + SDO_Model_Property::getName + Get the name of the SDO_Model_Property. + + + &reftitle.description; + + string + SDO_Model_Property::getName + + + + &warn.experimental.func; + + + Returns the name of the SDO_Model_Property. + + + + + &reftitle.parameters; + + None. + + + + &reftitle.returnvalues; + + Returns the name of the SDO_Model_Property. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-Property-getType.xml b/reference/sdo/functions/SDO-Model-Property-getType.xml new file mode 100644 index 0000000000..a2d55133e1 --- /dev/null +++ b/reference/sdo/functions/SDO-Model-Property-getType.xml @@ -0,0 +1,142 @@ + + + + + + SDO_Model_Property::getType + Get the SDO_Model_Type of the property. + + + &reftitle.description; + + SDO_Model_Type + SDO_Model_Property::getType + + + + &warn.experimental.func; + + + Get the SDO_Model_Type of the property. + The SDO_Model_Type describes the type information for the property, such + as its type name, namespace URI, whether it is a primitive data type, + and so on. + + + + + &reftitle.parameters; + + None. + + + + &reftitle.returnvalues; + + Returns the SDO_Model_Type describing the property's type information. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-Property-isContainment.xml b/reference/sdo/functions/SDO-Model-Property-isContainment.xml new file mode 100644 index 0000000000..01163a5dee --- /dev/null +++ b/reference/sdo/functions/SDO-Model-Property-isContainment.xml @@ -0,0 +1,144 @@ + + + + + + SDO_Model_Property::isContainment + + Test to see if the property defines a containment relationship. + + + + &reftitle.description; + + boolean + SDO_Model_Property::isContainment + + + + &warn.experimental.func; + + + Test to see if the property corresponds to a containment relationship. + Returns &true; if the property defines a containment relationship, + or &false; if it is reference. + + + + + &reftitle.parameters; + + None. + + + + &reftitle.returnvalues; + + Returns &true; if the property defines a containment relationship, + or &false; if it is reference. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-Property-isMany.xml b/reference/sdo/functions/SDO-Model-Property-isMany.xml new file mode 100644 index 0000000000..1a7905ca29 --- /dev/null +++ b/reference/sdo/functions/SDO-Model-Property-isMany.xml @@ -0,0 +1,142 @@ + + + + + + SDO_Model_Property::isMany + Test to see if the property is many-valued. + + + &reftitle.description; + + boolean + SDO_Model_Property::isMany + + + + &warn.experimental.func; + + + Test to see if the property is many-valued. + Returns &true; if this is a many-valued property, otherwise returns + &false;. + + + + + &reftitle.parameters; + + None. + + + + &reftitle.returnvalues; + + Returns &true; if this is a many-valued property, otherwise returns + &false;. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-ReflectionDataObject-construct.xml b/reference/sdo/functions/SDO-Model-ReflectionDataObject-construct.xml new file mode 100644 index 0000000000..58b1045163 --- /dev/null +++ b/reference/sdo/functions/SDO-Model-ReflectionDataObject-construct.xml @@ -0,0 +1,156 @@ + + + + + + SDO_Model_ReflectionDataObject::__construct + Construct an SDO_Model_ReflectionDataObject. + + + &reftitle.description; + + SDO_Model_ReflectionDataObject + SDO_Model_ReflectionDataObject::__construct + + SDO_DataObjectdata_object + + + + &warn.experimental.func; + + + Construct an SDO_Model_ReflectionDataObject to reflect on an + SDO_DataObject. Reflecting on an SDO_DataObject gives access to + information about its model. The model contains information such as + the data object's type, and whether that type is sequenced + (preserves ordering across properties) or open (each instance can have + its model extended). The model also holds information about the data + object's properties, any default values they may have, and so on. + + + + + &reftitle.parameters; + + + + data_object + + + The SDO_DataObject being reflected upon. + + + + + + + + &reftitle.returnvalues; + + None. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-ReflectionDataObject-getContainmentProperty.xml b/reference/sdo/functions/SDO-Model-ReflectionDataObject-getContainmentProperty.xml new file mode 100644 index 0000000000..479821b44c --- /dev/null +++ b/reference/sdo/functions/SDO-Model-ReflectionDataObject-getContainmentProperty.xml @@ -0,0 +1,146 @@ + + + + + + SDO_Model_ReflectionDataObject::getContainmentProperty + Get the parent's SDO_Model_Property which defines the + containment relationship to the reflected data object. + + + + &reftitle.description; + + SDO_Model_Property + + SDO_Model_ReflectionDataObject::getContainmentProperty + + + + + &warn.experimental.func; + + + Get the SDO_Model_Property that contains the SDO_DataObject. + This method is used to navigate up to the parent's property which + contains the data object which has been reflected upon. + + + + + &reftitle.parameters; + + None. + + + + &reftitle.returnvalues; + + Returns the container's SDO_Model_Property which references the + SDO_DataObject, or &null; if it is a root SDO_DataObject. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-ReflectionDataObject-getInstanceProperties.xml b/reference/sdo/functions/SDO-Model-ReflectionDataObject-getInstanceProperties.xml new file mode 100644 index 0000000000..76a1896fd8 --- /dev/null +++ b/reference/sdo/functions/SDO-Model-ReflectionDataObject-getInstanceProperties.xml @@ -0,0 +1,144 @@ + + + + + + SDO_Model_ReflectionDataObject::getInstanceProperties + Get the instance properties of the SDO_DataObject. + + + &reftitle.description; + + array + + SDO_Model_ReflectionDataObject::getInstanceProperties + + + + + &warn.experimental.func; + + + Get the instance properties for the SDO_DataObject. The instance + properties consist of all the properties defined on the data object's + type, plus any instance properties from open content (if the data object + is an open type). + + + + + &reftitle.parameters; + + None. + + + + &reftitle.returnvalues; + + An array of SDO_Model_Property objects. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-ReflectionDataObject-getType.xml b/reference/sdo/functions/SDO-Model-ReflectionDataObject-getType.xml new file mode 100644 index 0000000000..52f7b6ed60 --- /dev/null +++ b/reference/sdo/functions/SDO-Model-ReflectionDataObject-getType.xml @@ -0,0 +1,141 @@ + + + + + + SDO_Model_ReflectionDataObject::getType + Get the SDO_Model_Type for the SDO_DataObject. + + + &reftitle.description; + + SDO_Model_Type + SDO_Model_ReflectionDataObject::getType + + + + &warn.experimental.func; + + + Returns the SDO_Model_Type for the SDO_DataObject. The SDO_Model_Type + holds all the information about the data object's type, such as namespace + URI, type name, whether it is a primitive data type, and so on. + + + + + &reftitle.parameters; + + None. + + + + &reftitle.returnvalues; + + Returns the SDO_Model_Type for the SDO_DataObject. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-Type-getBaseType.xml b/reference/sdo/functions/SDO-Model-Type-getBaseType.xml new file mode 100644 index 0000000000..dad0a64d56 --- /dev/null +++ b/reference/sdo/functions/SDO-Model-Type-getBaseType.xml @@ -0,0 +1,144 @@ + + + + + + SDO_Model_Type::getBaseType + Get the base type for this type. + + + &reftitle.description; + + SDO_Model_Type + SDO_Model_Type::getBaseType + + + + &warn.experimental.func; + + + Get the base type for this type. + Returns the SDO_Model_Type for the base type if this type inherits from + another, otherwise returns &null;. An example of when base types occur + is when a type defined in XML schema inherits from another type by using + ]]>. + + + + + &reftitle.parameters; + + None. + + + + &reftitle.returnvalues; + + Returns the SDO_Model_Type for the base type if this type inherits from + another, otherwise returns &null;. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-Type-getName.xml b/reference/sdo/functions/SDO-Model-Type-getName.xml new file mode 100644 index 0000000000..3134147a6d --- /dev/null +++ b/reference/sdo/functions/SDO-Model-Type-getName.xml @@ -0,0 +1,139 @@ + + + + + + SDO_Model_Type::getName + Get the name of the type. + + + &reftitle.description; + + stringSDO_Model_Type::getName + + + + &warn.experimental.func; + + + Returns the name of the type. The combination of type name and namespace + URI is used to uniquely identify the type. + + + + + &reftitle.parameters; + + None. + + + + &reftitle.returnvalues; + + Returns the name of the type. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-Type-getNamespaceURI.xml b/reference/sdo/functions/SDO-Model-Type-getNamespaceURI.xml new file mode 100644 index 0000000000..e9c3cd83bd --- /dev/null +++ b/reference/sdo/functions/SDO-Model-Type-getNamespaceURI.xml @@ -0,0 +1,140 @@ + + + + + + SDO_Model_Type::getNamespaceURI + Get the namespace URI of the type. + + + &reftitle.description; + + string + SDO_Model_Type::getNamespaceURI + + + + &warn.experimental.func; + + + Returns the namespace URI of the type. The combination of namespace URI + and type name is used to uniquely identify the type. + + + + + &reftitle.parameters; + + None. + + + + &reftitle.returnvalues; + + Returns the namespace URI of the type. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-Type-getProperties.xml b/reference/sdo/functions/SDO-Model-Type-getProperties.xml new file mode 100644 index 0000000000..bce03ef839 --- /dev/null +++ b/reference/sdo/functions/SDO-Model-Type-getProperties.xml @@ -0,0 +1,142 @@ + + + + + + SDO_Model_Type::getProperties + + Get the SDO_Model_Property objects defined for the type. + + + + &reftitle.description; + + arraySDO_Model_Type::getProperties + + + + &warn.experimental.func; + + + Get an array of SDO_Model_Property objects describing the properties + defined for the SDO_Model_Type. Each SDO_Model_Property holds + information such as the property name, default value, and so on. + + + + + &reftitle.parameters; + + None. + + + + &reftitle.returnvalues; + + Returns an array of SDO_Model_Property objects. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-Type-getProperty.xml b/reference/sdo/functions/SDO-Model-Type-getProperty.xml new file mode 100644 index 0000000000..87a3e1ccf0 --- /dev/null +++ b/reference/sdo/functions/SDO-Model-Type-getProperty.xml @@ -0,0 +1,151 @@ + + + + + + SDO_Model_Type::getProperty + Get an SDO_Model_Property of the type. + + + &reftitle.description; + + SDO_Model_Property + SDO_Model_Type::getProperty + + mixedidentifier + + + + &warn.experimental.func; + + + Get an SDO_Model_Property of the type, identified by its property index + or property name. + + + + + &reftitle.parameters; + + + + identifier + + + The property index or property name. + + + + + + + + &reftitle.returnvalues; + + Returns the SDO_Model_Property. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-Type-isDataType.xml b/reference/sdo/functions/SDO-Model-Type-isDataType.xml new file mode 100644 index 0000000000..931d1d36e2 --- /dev/null +++ b/reference/sdo/functions/SDO-Model-Type-isDataType.xml @@ -0,0 +1,143 @@ + + + + + + SDO_Model_Type::isDataType + + Test to see if this SDO_Model_Type is a primitive data type. + + + + &reftitle.description; + + booleanSDO_Model_Type::isDataType + + + + &warn.experimental.func; + + + Test to see if this SDO_Model_Type is a primitive data type. + Returns &true; if this type is a primitive data type, otherwise returns + &false;. + + + + + &reftitle.parameters; + + None. + + + + &reftitle.returnvalues; + + Returns &true; if this type is a primitive data type, otherwise returns + &false;. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-Type-isInstance.xml b/reference/sdo/functions/SDO-Model-Type-isInstance.xml new file mode 100644 index 0000000000..074870d929 --- /dev/null +++ b/reference/sdo/functions/SDO-Model-Type-isInstance.xml @@ -0,0 +1,154 @@ + + + + + + SDO_Model_Type::isInstance + + Test for an SDO_DataObject being an instance of this SDO_Model_Type. + + + + &reftitle.description; + + booleanSDO_Model_Type::isInstance + + SDO_DataObjectdata_object + + + + &warn.experimental.func; + + + Test for an SDO_DataObject being an instance of this SDO_Model_Type. + Returns &true; if the SDO_DataObject provided is an instance of this + SDO_Model_Type, otherwise returns &false;. + + + + + &reftitle.parameters; + + + + data_object + + + The SDO_DataObject to be tested. + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the SDO_DataObject provided is an instance of this + SDO_Model_Type, otherwise returns &false;. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-Type-isOpenType.xml b/reference/sdo/functions/SDO-Model-Type-isOpenType.xml new file mode 100644 index 0000000000..e9bc0c37d0 --- /dev/null +++ b/reference/sdo/functions/SDO-Model-Type-isOpenType.xml @@ -0,0 +1,144 @@ + + + + + + SDO_Model_Type::isOpenType + Test to see if this type is an open type. + + + &reftitle.description; + + boolean + SDO_Model_Type::isOpenType + + + + &warn.experimental.func; + + + Test to see if this type is open. + Returns &true; if this type is open, otherwise returns &false;. An + SDO_DataObject whose type is open can have properties added to them which + are not described by the type. This capability is used to support + working with XML documents whose schema support open content, such as that + defined by an ]]> element. + + + + + &reftitle.parameters; + + None. + + + + &reftitle.returnvalues; + + Returns &true; if this type is open, otherwise returns &false;. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Model-Type-isSequencedType.xml b/reference/sdo/functions/SDO-Model-Type-isSequencedType.xml new file mode 100644 index 0000000000..63e2e6fdac --- /dev/null +++ b/reference/sdo/functions/SDO-Model-Type-isSequencedType.xml @@ -0,0 +1,145 @@ + + + + + + SDO_Model_Type::isSequencedType + Test to see if this is a sequenced type. + + + &reftitle.description; + + boolean + SDO_Model_Type::isSequencedType + + + + &warn.experimental.func; + + + Test to see if this is a sequenced type. Returns &true; if this type is + sequence, otherwise returns &false;. + Sequenced types can have the ordering across properties preserved and can + contain unstructured text. For more information on sequenced types see + the section on + Working with Sequenced Data Objects + . + + + + + &reftitle.parameters; + + None. + + + + &reftitle.returnvalues; + + Returns &true; if this type is sequence, otherwise return &false;. + + + + + + + + + + + + + + + + + + diff --git a/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml b/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml index 6a2118a795..4610977b29 100644 --- a/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml +++ b/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml @@ -1,6 +1,7 @@ - - + + SDO_Sequence::getPropertyIndex diff --git a/reference/sdo/functions/SDO-Sequence-getPropertyName.xml b/reference/sdo/functions/SDO-Sequence-getPropertyName.xml index b184711e68..84e022e8e9 100644 --- a/reference/sdo/functions/SDO-Sequence-getPropertyName.xml +++ b/reference/sdo/functions/SDO-Sequence-getPropertyName.xml @@ -1,6 +1,7 @@ - - + + SDO_Sequence::getPropertyName diff --git a/reference/sdo/functions/SDO-Sequence-insert.xml b/reference/sdo/functions/SDO-Sequence-insert.xml index aeaae96dd6..8ed35fdf48 100644 --- a/reference/sdo/functions/SDO-Sequence-insert.xml +++ b/reference/sdo/functions/SDO-Sequence-insert.xml @@ -1,6 +1,7 @@ - - + + SDO_Sequence::insert diff --git a/reference/sdo/functions/SDO-Sequence-move.xml b/reference/sdo/functions/SDO-Sequence-move.xml index 940677de19..a90213538b 100644 --- a/reference/sdo/functions/SDO-Sequence-move.xml +++ b/reference/sdo/functions/SDO-Sequence-move.xml @@ -1,6 +1,7 @@ - - + + SDO_Sequence::move diff --git a/reference/sdo/reference.xml b/reference/sdo/reference.xml index 7bec714e58..9da3fb793a 100644 --- a/reference/sdo/reference.xml +++ b/reference/sdo/reference.xml @@ -1,5 +1,5 @@ - + @@ -50,12 +50,12 @@ The Structure of a Service Data Object A Service Data Object instance is made up of a tree of data objects. - The tree is defined by containment references between the data objects. - For example, a Company data object might consist of a number of - Department data objects and therefore the Company would have - a containment reference to the Departments. - Deleting a data object which has a containment reference to another - data object will delete the referenced data object. For example, + The tree is defined by containment relationships between the data + objects. For example, a Company data object might consist of a number + of Department data objects and therefore the Company would have + a containment relationship to the Departments. + Deleting a data object which has a containment relationship to another + data object will also delete the contained data object. For example, deleting the Company data object will also delete the Departments. @@ -121,10 +121,11 @@ - The latest DLLs for the SDO core and the XML DAS can be downloaded from - php_sdo + The latest DLLs for the SDO core and the XML DAS can be + downloaded from + php_sdo and - php_sdo_das_xml + php_sdo_das_xml respectively. @@ -207,8 +208,8 @@ sdo-0.5.2, in the command above. - This command will build the SDO and XML shared libraries as well as - installing the PHP files that make the Relational DAS. + This command will build the SDO and XML shared libraries as well + as installing the PHP files that make the Relational DAS. @@ -370,11 +371,6 @@ extension=sdo_das_xml.so Read-only properties. - - - Model introspection. - - XMLHelper/XSDHelper (the XML DAS provide a lot of this functionality) @@ -416,14 +412,16 @@ extension=sdo_das_xml.so - + - + @@ -452,7 +450,8 @@ sdoxml:propertyType="company:EmployeeType"/> - + @@ -677,7 +676,8 @@ sdoxml:propertyType="company:EmployeeType"/> ]]> @@ -717,7 +717,7 @@ sdoxml:propertyType="company:EmployeeType"/> The following removes the 'employeeOfTheMonth' from the company. - If this were a containment reference then the + If this were a containment relationship then the employee would be removed from the company (probably not a good idea to sack your best employee each month!), but since this is a non-containment reference, @@ -1026,16 +1026,116 @@ sdoxml:propertyType="company:EmployeeType"/> + +
+ Reflecting on Service Data Objects + + SDOs have a knowledge of the structure they have been created to + represent (the model). For example, a Company SDO created using + the Company XML schema above + would only be permitted to contain DepartmentType data objects + which in turn could only contain EmployeeType data objects. + + + Sometimes it is useful to be able to access this model information at + runtime. For example, this could be used to automatically generate + a user interface for populating a data object. The model information + is accessed using reflection. + + + + + Reflecting on a Data Object + + The following example shows how we can reflect on an empty Employee + data object. + + + +]]> + + &example.outputs; + + + + + + Using print on the SDO_Model_ReflectionDataObject writes out the data + object's model. We can see from the output how the type + companyNS:EmployeeType has three properties and we can see the names + of the properties along with their types. Note, the primitive types + are listed as SDO types (e.g. commonj.sdo namespace, String type). + It is worth noting that this is the SDO model and when these are + surfaced to an application they can be treated as the PHP equivalent + types (e.g. string and boolean). + + + + + + + Accessing the type information + + We can query the type information of a data object using reflection. + The following example checks the type corresponds to a data object + rather than a primitive and then iterates through the properties of + the type, writing out the name of each property ($type and $property + are SDO_Model_Type and SDO_Model_Property objects, respectively). + + +getType(); + if (! $type->isDataType()) { + foreach ($type->getProperties() as $property) { + print $property->getName() . "\n"; + } + } +?> +]]> + + &example.outputs; + + + + + + +
+ + + + +
&reftitle.classes; - SDO consists of two sets of interfaces. The first set covers those - interfaces for use by SDO client applications. These are identified by - the package prefix 'SDO_'. The second set is those for use by Data - Access Service implementations and are identified by the package prefix - 'SDO_DAS_'. The majority of SDO users will not need to use or understand - the 'SDO_DAS_' interfaces. + SDO consists of three sets of interfaces. The first set covers those + interfaces for use by typical SDO applications. These are identified + by the package prefix 'SDO_'. The second set is those used to reflect + on, and work with, the model of a data object. These are identified + by the package prefix 'SDO_Model_'. Finally, the third set are those + use by Data Access Service implementations and are identified by the + package prefix 'SDO_DAS_'. The majority of SDO users will not need to + use or understand the 'SDO_Model_ and 'SDO_DAS_' interfaces.
@@ -1054,12 +1154,6 @@ sdoxml:propertyType="company:EmployeeType"/>
&reftitle.methods; - - - getType - - get the type of a data object - - @@ -1088,14 +1182,6 @@ sdoxml:propertyType="company:EmployeeType"/> - get the container (also known as 'parent') of this data object - - - - getContainmentPropertyName - - - get the name by which the parent refers to this data object - -
@@ -1198,6 +1284,200 @@ sdoxml:propertyType="company:EmployeeType"/>
+ + +
+ SDO Reflection Application Programmer Interfaces + +
+ + <classname>SDO_Model_ReflectionDataObject</classname> + + + The main interface used to reflect on a data object instance + to obtain its model type and property information. + It is designed to follow the reflection pattern introduced in PHP 5. + +
+ &reftitle.methods; + + + + + __construct + - construct a new SDO_Model_ReflectionDataObject. + + + + + + getType + - get the SDO_Model_Type for the data object. + + + + + + getInstanceProperties + - get the instance properties of the data object. + + + + + + getContainmentProperty + - get the parent's SDO_Model_Property which defines the + containment relationship to the reflected data object. + + + +
+
+ +
+ + <classname>SDO_Model_Type</classname> + + + The interface through which a data object's type information can be + retrieved. This interface can be used to find out the type name and + namespace URI of the type, whether the type allow open content, and so + on. + +
&reftitle.methods; + + + + + getName + - get the name of the type. + + + + + + getNamespaceURI + - get the namespace URI of the type. + + + + + + isInstance + - test for a data object being an instance of the type. + + + + + + getProperties + - get the properties of the type. + + + + + + getProperty + - get a property of the type. + + + + + + isDataType + - test to see if this type is a primitive scalar type. + + + + + + isSequencedType + - test to see if this is a sequenced type. + + + + + + isOpenType + - test to see if this is an open type. + + + + + + getBaseType + - get the base type of this type (if one exists). + + + +
+
+ +
+ + <classname>SDO_Model_Property</classname> + + + The interface through which a data object's property information can + be retrieved. This interface can be used to find out the type of a + property, whether a property has a default value, whether the + property is contained or reference by its parent, its cardinality, + and so on. + +
&reftitle.methods; + + + + + getName + - get the name of the property. + + + + + + getType + - get the type of the property. + + + + + + isMany + - test to see if the property is many-valued.. + + + + + + isContainment + - test to see if the property describes a containment relationship. + + + + + + getContainingType + - get the type which contains this property. + + + + + + getDefault + - get the default value for a property. + + + +
+
+ + + +
+
SDO Data Access Service Developer Interfaces diff --git a/reference/sdo_das_xml/reference.xml b/reference/sdo_das_xml/reference.xml index 90cc4c2ac2..45a0fa58f2 100644 --- a/reference/sdo_das_xml/reference.xml +++ b/reference/sdo_das_xml/reference.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.12 $ --> +<!-- $Revision: 1.13 $ --> <!-- Purpose: xml --> <!-- Membership: pecl --> <!-- State: experimental --> @@ -386,20 +386,19 @@ try { try { $xmldas = SDO_DAS_XML::create("letter.xsd"); try { - $do = $xmldas->createDataObject("http://letterSchema", "FormLetter"); - $seq = $do->getSequence(); - $seq->insert("April 09, 2005", NULL, 'date'); - $seq->insert("Acme Inc. ", NULL, NULL); - $seq->insert("United Kingdom. "); - $seq->insert("Dear", NULL, NULL); - $seq->insert("Tarun", NULL, "firstName"); - $seq->insert("Nayaraaa", NULL, "lastName"); - $do->lastName = "Nayar"; - $seq->insert("Please note that your order number "); - $seq->insert(12345); - $seq->insert(" has been dispatched today. Thanks for your business with us."); - $type = $do->getType(); - print($xmldas->saveDataObjectToString($do, $type[0], $type[1])); + $letter = $xmldas->createDataObject("http://letterSchema", "FormLetter"); + $letter_seq = $letter->getSequence(); + $letter_seq->insert("April 09, 2005", NULL, 'date'); + $letter_seq->insert("Acme Inc. ", NULL, NULL); + $letter_seq->insert("United Kingdom. "); + $letter_seq->insert("Dear", NULL, NULL); + $letter_seq->insert("Tarun", NULL, "firstName"); + $letter_seq->insert("Nayaraaa", NULL, "lastName"); + $letter->lastName = "Nayar"; + $letter_seq->insert("Please note that your order number "); + $letter_seq->insert(12345); + $letter_seq->insert(" has been dispatched today. Thanks for your business with us."); + print($xmldas->saveDataObjectToString($letter, "http://letterSchema", "FormLetter")); } catch (SDO_Exception $e) { print($e); } diff --git a/reference/sdodasrel/reference.xml b/reference/sdodasrel/reference.xml index 4a5e9dbc50..e3fcf74d7c 100644 --- a/reference/sdodasrel/reference.xml +++ b/reference/sdodasrel/reference.xml @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.17 $ --> +<!-- $Revision: 1.18 $ --> <!-- Purpose: database.abstract --> <!-- Membership: pecl --> <!-- State: experimental --> @@ -37,7 +37,7 @@ the mapping between the database entities - tables, columns, primary keys and foreign keys - and the elements of the SDO model - - types, properties, containment properties and so on. + - types, properties, containment relationships and so on. You specify this information as metadata when you construct the Relational DAS. </para> @@ -76,7 +76,7 @@ is a normalised data graph containing all the data from the result set. For a query that returns data obtained from a number of tables, this graph will contain a number of data objects, - linked by SDO containment references. + linked by SDO containment relationships. There may also be SDO non-containment references within the data. </para> @@ -248,10 +248,10 @@ require_once 'SDO/DAS/Relational.php'; <para> Only two types of SDO relationship. The metadata described below allows the Relational DAS to model just two types of SDO relationship: - multi-valued containment properties and single-valued - non-containment properties. In SDO, whether a property is - single- or multi-valued, and whether it is containment or - non-containment, are independent. The full range of possibilities + multi-valued containment relationships and single-valued + non-containment references. In SDO, whether a property describes a + single- or multi-valued relationship, and whether it is containment + or non-containment, are independent. The full range of possibilities that SDO allows cannot all be defined. There may be relationships that it would be useful to model but which the current implementation cannot manage. @@ -619,8 +619,8 @@ create table employee ( \ metadata in the third argument to the constructor that defines the SDO containment relationships. A discussion of this is therefore deferred until the section on - <link linkend="sdo.das.rel.metadata.crefs"> - SDO containment references + <link linkend="sdo.das.rel.metadata.crels"> + SDO containment relationships </link> below. </para> @@ -640,8 +640,8 @@ create table employee ( \ </para> </section> - <section id='sdo.das.rel.metadata.crefs'> - <title>Specifying the SDO containment references +
+ Specifying the SDO containment relationships The third argument to the constructor defines how the types in the @@ -655,38 +655,38 @@ create table employee ( \ The metadata is an array containing one or more associative arrays, each of which identifies a parent and a child. The example below shows a parent-child relationship from company to department, and another - from department to employee. Each of these will become an SDO - multi-valued containment property in the SDO model. + from department to employee. Each of these will become an SDO property + defining a multi-valued containment relationship in the SDO model. 'company', 'child' => 'department'); -$employee_reference = array( 'parent' => 'department', 'child' => 'employee'); +$department_containment = array( 'parent' => 'company', 'child' => 'department'); +$employee_containment = array( 'parent' => 'department', 'child' => 'employee'); -$SDO_reference_metadata = array($department_reference, $employee_reference); +$SDO_containment_metadata = array($department_containment, $employee_containment); ?> ]]> - Foreign keys in the database metadata are interpreted as either - multi-valued containment properties or single-valued non-containment - properties, depending on whether they have a corresponding SDO - containment reference specified in the metadata. In the example here, - the foreign keys from department to company (the + Foreign keys in the database metadata are interpreted as properties + with either multi-valued containment relationships or single-valued + non-containment references, depending on whether they have a + corresponding SDO containment relationship specified in the metadata. + In the example here, the foreign keys from department to company (the co_id column in the department table) and from employee to department (the dept_id column in the employee table) are interpreted as supporting the - SDO containment references. - Each containment reference mentioned in the SDO containment references + SDO containment relationships. + Each containment relationship mentioned in the SDO containment relationships metadata must have a corresponding foreign key present in the database and defined in the database metadata. The values of the - foreign key columns for containment references do not appear in the - data objects, instead they are represented by the containment reference + foreign key columns for containment relationships do not appear in the + data objects, instead each is represented by a containment relationship from the parent to the child. So the co_id column in the department row in the database, for example, does not @@ -705,14 +705,14 @@ $SDO_reference_metadata = array($department_reference, $employee_reference); employee_of_the_month , is handled differently. - This is not mentioned in the SDO containment references metadata. + This is not mentioned in the SDO containment relationships metadata. As a consequence this is interpreted in the second way: it becomes a single-valued non-containment reference on the company object, to which can be assigned references to SDO data objects of the employee type. It does appear as a property on the company type. The way to assign a value to it in the SDO data graph is to have a graph that - contains an employee object through the containment references, and to - assign the object to it. This is illustrated in the later examples + contains an employee object through the containment relationships, and + to assign the object to it. This is illustrated in the later examples below.
@@ -781,7 +781,7 @@ require_once 'company_metadata.inc.php'; /************************************************************** * Construct the DAS with the metadata ***************************************************************/ -$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata); +$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata); /************************************************************** * Obtain a root object and create a company object underneath. @@ -834,7 +834,7 @@ require_once 'company_metadata.inc.php'; /************************************************************** * Construct the DAS with the metadata ***************************************************************/ -$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata); +$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata); /************************************************************** * Get a database connection @@ -893,7 +893,7 @@ require_once 'company_metadata.inc.php'; /************************************************************** * Construct the DAS with the metadata ***************************************************************/ -$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata); +$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata); /************************************************************** * Get a database connection @@ -934,7 +934,8 @@ $das->applyChanges($dbh,$root); In this example they are all deleted in one go by unsetting the - containing reference. It is also possible to delete them individually. + containing property (the property defining the containment + relationship). It is also possible to delete them individually. execute(); * Create a company with name Acme and one department, the Shoe department ***************************************************************/ $dbh = new PDO(PDO_DSN,DATABASE_USER,DATABASE_PASSWORD); -$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata); +$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata); $root = $das -> createRootDataObject(); @@ -1121,7 +1122,7 @@ require_once 'company_metadata.inc.php'; * Retrieve the company and Shoe department, then delete Shoe and add IT ***************************************************************/ $dbh = new PDO(PDO_DSN,DATABASE_USER,DATABASE_PASSWORD); -$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata); +$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata); $root = $das->executeQuery($dbh, 'select c.id, c.name, d.id, d.name from company c, department d where d.co_id = c.id', @@ -1154,8 +1155,8 @@ $das -> applyChanges($dbh, $root); Note the way that the company object is actually deleted using the PHP unset call. The unset has to be performed on the containing - reference which in this case is - the company reference on the special + property which in this case is + the company property on the special root object. You must use: executeQuery($dbh, 'select c.id, c.name, d.id, d.name from company c, department d where d.co_id = c.id', @@ -1246,7 +1247,7 @@ $das -> applyChanges($dbh, $root); property. The closure rule for SDO data graphs requires that any object pointed at by a non-containment reference must also be reachable by - containment references. + containment relationships. When it comes to inserting the graph into the database, the procedure @@ -1255,7 +1256,7 @@ $das -> applyChanges($dbh, $root); employee_of_the_month introduces an extra complexity. The Relational DAS needs to insert the objects working down the tree - formed by containment references, so company, then department, then + formed by containment relationships, so company, then department, then employee. This is necessary so that it always has the auto-generated primary key of a parent on hand to include in a child row. But when the company row is inserted the employee who is employee of the month @@ -1288,7 +1289,7 @@ $rows_affected = $pdo_stmt->execute(); * There is one employee, Sue. * The employee of the month is Sue. *************************************************************************************/ -$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata); +$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata); $dbh = new PDO(PDO_DSN,DATABASE_USER,DATABASE_PASSWORD); $root = $das -> createRootDataObject(); @@ -1337,7 +1338,7 @@ require_once 'company_metadata.inc.php'; * Add a second department and a new employee. * Change the employee of the month. *************************************************************************************/ -$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata); +$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata); $dbh = new PDO(PDO_DSN,DATABASE_USER,DATABASE_PASSWORD); $root = $das->executeQuery($dbh, @@ -1396,7 +1397,7 @@ require_once 'company_metadata.inc.php'; * care is needed to keep closure - you cannot delete the employee who is eotm without * reassigning. For safety here we delete the company all in one go. *************************************************************************************/ -$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata); +$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata); $dbh = new PDO(PDO_DSN,DATABASE_USER,DATABASE_PASSWORD); $root = $das->executeQuery($dbh,