archived-doc-es/reference/sdo/reference.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 14af302c9c0e561fa6f9cdd956268758ba9a89c5 Maintainer: seros Status: ready -->
<!-- Reviewed: no -->

<reference xml:id="ref.sdo" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <title>&Functions; de SDO</title>
 
 <partintro>
  <section xml:id="sdo.das.table">
   <title>Servicios de Acceso a Datos</title>
   <para>
    La tabla de abajo enumera los Servicios de Acceso a Datos (DAS) de SDO proporcionados actualmente:
    <informaltable>
     <tgroup cols="2">
      <thead>
       <row>
        <entry>Nombre del DAS</entry>
        <entry>Descripción</entry>
       </row>
      </thead>
      <tbody>
       <row>
        <entry>
         <link linkend="ref.sdo-das-xml">SDO_DAS_XML</link>
        </entry>
        <entry>
         Un Servicio de Acceso a Datos XML que admite la lectura/escritura
         de SDOs como documentos XML.
        </entry>
       </row>
       <row>
        <entry>
         <link linkend="ref.sdodasrel">SDO_DAS_Relational</link>
        </entry>
        <entry>
         Un Servicio de Acceso a Datos basado en PDO que admite la lectura/escritura de SDOs
         de bases de datos relacionales.
         Implementa una política de concurrencia optimista para actualizaciones.
        </entry>
       </row>
      </tbody>
     </tgroup>
    </informaltable>
   </para>
  </section>
  
  <!-- FIXME: Everything below should be removed and follow our OO skeletons -->
  
  <!-- class definition section -->
  <section xml:id="sdo.classes">
   &reftitle.classes;
   <para>
    SDO consiste en tres conjuntos de interfaces. El primer conjunto cubre aquellas
    interfaces usadas por las aplicaciones SDO típicas. Están identificadas
    por el prefijo de paquete 'SDO_'. El segundo conjunto son aquellas usadas para reflejar,
    y trabajar con, el modelo de un objeto de datos. Están identificadas
    por el prefijo de paquete 'SDO_Model_'. Finalmente, el tercer conunto son aquellas
    usadas por las implementaciones de Servicio de Acceso a Datos y están identificadas por el
    prefijo de paquete 'SDO_DAS_'. La mayoría de los usuarios de SDO no necesitarán
    usar o comprender las interfaces 'SDO_Model_' y 'SDO_DAS_'.
   </para>
   
   <section xml:id="sdo.class.sdo-apis">
    <title>Interfaz del Programador de Aplicaciones SDO</title>
    
    <section xml:id="class.sdo-dataobject">
     <title>
      <classname>SDO_DataObject</classname>
     </title>
     <para>
      Es la interfaz principal a través de la cual se manipulan los objetos de datos.
      Además de los métodos de abajo, SDO_DataObject amplía las interfaces
      ArrayAccess, SDO_PropertyAccess (define los métodos <link linkend="object.get">__get()</link> /
      <link linkend="object.set">__set()</link> para la sobrecarga de acceso a propiedades),
      Iterator, y Countable.
     </para>
     <section> &reftitle.methods;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sdo-dataobject.getsequence">getSequence</link>
         - obtener la secuencia para el objeto de datos
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-dataobject.createdataobject">createDataObject</link>
         - crear un objeto de datos hijo
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-dataobject.clear">clear</link>
         - desestablecer las propiedades de un objeto de datos
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-dataobject.getcontainer">getContainer</link>
         - obtener el contenedor (también conocido como 'padre') de este objeto de datos
        </para>
       </listitem>      
       <listitem>
        <para>
         <link linkend="sdo-dataobject.gettypename">getTypeName</link>
         - obtener el nombre del tipo de este objeto de datos
        </para>
       </listitem>     
       <listitem>
        <para>
         <link linkend="sdo-dataobject.gettypenamespaceuri">getTypeNamespaceURI</link>
         - obtener el URI del espacio de nombres del tipo de este objeto de datos
        </para>
       </listitem>
      </itemizedlist>
     </section>
    </section>
    
    <section xml:id="class.sdo-sequence">
     <title>
      <classname>SDO_Sequence</classname>
     </title>
     <para>
      Es la interfaz a través de la cual se puede acceder a los objetos de datos
      para mantener el orden de las propiedades de los objetos de datos y
      permitir texto no estructurado.
      SDO_Sequence mantiene los índices contiguos y, por consiguiente, al insertar
      o eliminar elementos, puede mover otros elementos hacia arriba o hacia
      abajo. Además de los métodos de abajo, SDO_Sequence amplía las interfaces
      ArrayAccess, Iterator y Countable.
     </para>
     <section>
      &reftitle.methods;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sdo-sequence.getproperty">getProperty</link> 
         - obtener la propiedad de un índice de secuencia dado
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-sequence.move">move</link>
         - mover un elemento desde un índice de propiedad a otro
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-sequence.insert">insert</link>
         - insertar un nuevo valor en la secuencia
        </para>
       </listitem>
      </itemizedlist>
     </section>
    </section>
    
    <section xml:id="class.sdo-list">
     <title>
      <classname>SDO_List</classname>
     </title>
     <para>
      Es la interfaz a través de la cual se manipulan las propiedades polievaluadas.
      Además de los métodos definidos abajo, SDO_List amplía ArrayAccess,
      Iterator y Countable.  SDO_List mantiene los índices contiguos y,
      por consiguiente, al insertar o eliminar elementos, puede mover otros elementos
      hacia arriba o hacia abajo.
     </para>
     <section>
      &reftitle.methods;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sdo-list.insert">insert</link> 
         - insertar un nuevo valor en la lista
        </para>
       </listitem>
      </itemizedlist>
     </section>
    </section>
    
    <section xml:id="class.sdo-datafactory">
     <title>
      <classname>SDO_DataFactory</classname>
     </title>
     <para>
      Es la interfaz a través de la cual se pueden crear objetos de datos.
      Un Servicio de Acceso a Datos es el responsable de rellenar el modelo
      (esto es, configurar la fábrica de datos con la información de tipo y
      estructura de los objetos de datos que puede crear) 
      para la fábrica y puede opcionalmente devolver una instancia de, 
      o implementar, la interfaz SDO_DataFactory.
     </para>
     <section>
      &reftitle.methods;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sdo-datafactory.create">create</link> 
         - crear un nuevo objeto de datos
        </para>
       </listitem>
      </itemizedlist>
     </section>
    </section>
    
    <section xml:id="class.sdo-exception">
     <title>
      <classname>SDO_Exception</classname>
     </title>
     <para>
      Una SDO_Exception es lanzada cuando no se puede completar la solicitud del llamador.
      Las subclases de SDO_Exception son:
      <itemizedlist>
       <listitem>
        <para>SDO_PropertyNotSetException -
         la propiedad especificada existe pero no ha sido establecida o no tiene un
         valor predeterminado.
        </para>
       </listitem>
       <listitem>
        <para>SDO_PropertyNotFoundException -
         la propiedad especificada no es parte del tipo de objeto de datos
        </para>
       </listitem>
       <listitem>
        <para>SDO_TypeNotFoundException -
         el URI del espacio de nombres o el nombre del tipo es desconocido
        </para>
       </listitem>
       <listitem>
        <para>SDO_InvalidConversionException -
         la conversión entre los tipos de la asignación no es posible
        </para>
       </listitem>
       <listitem>
        <para>SDO_IndexOutOfBoundsException -
         el índice numérico de un objeto de datos, la secuencia o la lista no están en el
         rango válido
        </para>
       </listitem>
       <listitem>
        <para>SDO_UnsupportedOperationException -
         la petición no puede ser completada debido a que no está permitida,
         por ejemplo, un intento de establecer una propiedad de sólo lectura.
        </para>
       </listitem>
      </itemizedlist>
     </para>
     <section> &reftitle.methods;
      <para>Se añade un método a aquellas clases que heredan de la clase interna
       <link linkend="language.exceptions.extending">Exception</link>:
      </para>
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sdo-exception.getcause">getCause</link> 
         - obtener la causa de esta SDO_Exception
        </para>
       </listitem>
       
      </itemizedlist>
     </section>
    </section>
    
   </section>
   
   
   
   <section xml:id="sdo.class.sdo-model-apis">
    <title>Interfaces del Programador de Aplicaciones de Reflexión de SDO</title>
    
    <section xml:id="class.sdo-model-reflectiondataobject">
     <title>
      <classname>SDO_Model_ReflectionDataObject</classname>
     </title>
     <para>
      Es la interfaz principal usada para reflejar una instancia de un objeto de datos
      para obtener la informaición de su tipo de modelo y propiedades.
      Está diseñada para seguir el patrón de reflexión introducido en PHP 5.
     </para>
     <section>
      &reftitle.constructor;     
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sdo-model-reflectiondataobject.construct">__construct</link>
         - construir un nuevo SDO_Model_ReflectionDataObject.
        </para>
        </listitem>     
      </itemizedlist>
     </section>
     <section>
      &reftitle.methods;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sdo-model-reflectiondataobject.export">export</link>
         - obtener un string que describe el objeto de datos.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-model-reflectiondataobject.gettype">getType</link>
         - obtener el SDO_Model_Type del objeto de datos.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend=
         'sdo-model-reflectiondataobject.getinstanceproperties'>getInstanceProperties</link>
         - obtener las propiedades de la instancia del objeto de datos.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend=
         'sdo-model-reflectiondataobject.getcontainmentproperty'>getContainmentProperty</link>
         - obtener la propiedad que define la relación de contención del objeto de datos.
        </para>
       </listitem>
      </itemizedlist>
     </section>
    </section>
    
    <section xml:id="class.sdo-model-type">
     <title>
      <classname>SDO_Model_Type</classname>
     </title>
     <para>
      Es la interfaz a través de al cual se puede recuperar la información del tipo de un objeto de
      datos. Esta interfaz se puede usar para averiguar el nombre del tipo y
      el URI del espacio de nombres del tipo, si el tipo permite contenido abierto,
      etc.
     </para>
     <section> &reftitle.methods;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sdo-model-type.getname">getName</link>
         - obtener el nombre del tipo.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-model-type.getnamespaceuri">getNamespaceURI</link>
         - obtener el URI del espacio de nombres del tipo.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-model-type.isinstance">isInstance</link>
         - comprobar que un objeto de datos es una instancia del tipo.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-model-type.getproperties">getProperties</link>
         - obtener las propiedades del tipo.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-model-type.getproperty">getProperty</link>
         - obtener una propiedad del tipo.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-model-type.isdatatype">isDataType</link>
         - comprobar si este tipo es un tipo escalar primitivo.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-model-type.issequencedtype">isSequencedType</link>
         - comprobar si éste es un tipo secuenciado.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-model-type.isopentype">isOpenType</link>
         - comprobar si éste es un tipo abierto.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-model-type.isabstracttype">isAbstractType</link>
         - comprobar si éste es un tipo abstracto.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-model-type.getbasetype">getBaseType</link>
         - obtener el tipo base de este tipo (si existe uno).
        </para>
       </listitem>
      </itemizedlist>
     </section>
    </section>
    
    <section xml:id="class.sdo-model-property">
     <title>
      <classname>SDO_Model_Property</classname>
     </title>
     <para>
      Es la interfaz a través de la cual se puede recuperar la información de las propiedades de
      un objeto de datos. Esta interfaz se puede usar para averiguar el tipo de una
      propiedad, si una propiedad tiene un valor predeterminado, si la
      propiedad está contenida o hace referencia a su padre, su cardinalidad,
      etc.
     </para>
     <section> &reftitle.methods;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sdo-model-property.getname">getName</link>
         - obtener el nombre de la propiedad.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-model-property.gettype">getType</link>
         - obtener el tipo de la propiedad.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-model-property.ismany">isMany</link>
         - comprobar si la propiedad es polievaluada.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-model-property.iscontainment">isContainment</link>
         - comprobar si la propiedad describe una relación de contención.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-model-property.getcontainingtype">getContainingType</link>
         - obtener el tipo que contiene esta propiedad.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-model-property.getdefault">getDefault</link>
         - obtener el valor predeterminado de una propiedad.
        </para>
       </listitem>
      </itemizedlist>
     </section>
    </section>
    
    
    
   </section>
   
   <section xml:id="sdo.class.sdo-das-spis">
    <title>
     Interfaces del Desarrollador de Servicios de Acceso a Datos de SDO
    </title>
    
    <section xml:id="class.sdo-das-dataobject">
     <title>
      <classname>SDO_DAS_DataObject</classname>
     </title>
     <para>
      Es la interfaz a través de la cual un Servicio de Acceso a Datos puede acceder
      al <link linkend="class.sdo-das-changesummary">SDO_DAS_ChangeSummary</link>
      de un objeto de datos.
      El resumen de cambios es usado por el Servicio de Acceso a Datos para comprobar si hay
      conflictos al aplicar los cambios a una fuente de datos.
     </para>
     <section> &reftitle.methods;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sdo-das-dataobject.getchangesummary">getChangeSummary</link> 
         - obtener el resumen de cambios de un objeto de datos
        </para>
       </listitem>
       
      </itemizedlist>
     </section>
    </section>
    
    <section xml:id="class.sdo-das-changesummary">
     <title>
      <classname>SDO_DAS_ChangeSummary</classname>
     </title>
     <para>
      Es la interfaz a través de la cual se accede al historial de cambios de un
      objeto de datos. El resumen de cambios contiene información de cualquier
      modificación hecha a un objeto de datos que suceda desde que la identificación
      fue activada. En el caso de eliminaciones y modificaciones, los valores
      antiguos también están contenidos en el resumen de cambios.
     </para>
     <para>
      Si la identificación ya no está activa,
      el resumen de cambios sólo contendrá los cambios hechos hasta el punto donde
      la identificación fue desactivada.
      La reactivación de la identificación limpia el resumen de cambios.
      Esto es útil cuado un conjunto de cambios ha sido escrito por un
      DAS y el objeto de datos va a ser reusado.
     </para>
     <section>
      &reftitle.methods;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sdo-das-changesummary.beginlogging">beginLogging</link> 
         - comenzar a registrar los cambios hechos en un objeto de datos
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-das-changesummary.endlogging">endLogging</link> 
         - finalizar de registrar los cambios hechos en un objeto de datos
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-das-changesummary.islogging">isLogging</link> 
         - comprobar si el registro de cambios está activad
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-das-changesummary.getchangeddataobjects">getChangedDataObjects</link> 
         - obtener una lista de los objetos de datos que han sido cambiados
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-das-changesummary.getchangetype">getChangeType</link> 
         - obtener el tipo de cambio hecho a un objeto de datos
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-das-changesummary.getoldvalues">getOldValues</link> 
         - obtener una lista de los valores antiguos de un objeto de datos
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-das-changesummary.getoldcontainer">getOldContainer</link> 
         - obtener el objeto de datos contenedor antiguo de un objeto de datos eliminado
        </para>
       </listitem>
      </itemizedlist>
     </section>
    </section>
    
    <section xml:id="class.sdo-das-setting">
     <title>
      <classname>SDO_DAS_Setting</classname>
     </title>
     <para>
      Es la interfaz a través de la cual se accede al valor antiguo de una
      propiedad. El método de resumen de cambios <link linkend="sdo-das-changesummary.getoldvalues">getOldValues</link>
      devuelve una lista.
     </para>
     <section>
      &reftitle.methods;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sdo-das-setting.getpropertyindex">getPropertyIndex</link> 
         - obtener el índice de la propiedad cambiada
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-das-setting.getpropertyname">getPropertyName</link> 
         - obtener el nombre de la propiedad cambiada
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-das-setting.getvalue">getValue</link> 
         - obtener el valor antiguo de la propiedad cambiada
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-das-setting.getlistindex">getListIndex</link> 
         - obtener el índice de la lista del valor antiguo si era parte de una
         propiedad polievaluada.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sdo-das-setting.isset">isSet</link>
         - comprobar si la propiedad estaba establecida antes de ser modificada
        </para>
       </listitem>
      </itemizedlist>
     </section>
    </section>
    
    <section xml:id="class.sdo-das-datafactory">
     <title>
      <classname>SDO_DAS_DataFactory</classname>
     </title>
     <para>
      Es la interfaz para contruir el modelo de un SDO_DataObject.
      SDO_DAS_DataFactory es una clase abstracta que proporciona un método
      estático que devuelve una implementación de fábrica de datos concreta.
      La implementación es usada por los Servicios de Acceso a Datos para crear un
      modelo SDO a partir de su modelo.
      Por ejemplo, un Servicio de Acceso a Datos Relacionales podría crear y rellenar
      un modelo SDO_DAS_DataFactory basado en un esquema de una base de datos
      relacional.
     </para>
     <section>
      &reftitle.methods;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sdo-das-datafactory.getdatafactory">getDataFactory</link> 
         - método estático para obtener una instancia de una fábrica de datos concreta
        </para>
       </listitem>
      </itemizedlist>
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sdo-das-datafactory.addtype">addType</link> 
         - añadir un nuevo tipo al modelo SDO
        </para>
       </listitem>
      </itemizedlist>
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sdo-das-datafactory.addpropertytotype">addPropertyToType</link> 
         - añadir una nueva propiedad a una definición de tipo en el modelo SDO
        </para>
       </listitem>
      </itemizedlist>
     </section>
    </section>
   </section>
  </section>
  
 </partintro>
 
 &reference.sdo.entities.sdo-das-changesummary;
 &reference.sdo.entities.sdo-das-datafactory;
 &reference.sdo.entities.sdo-das-dataobject;
 &reference.sdo.entities.sdo-das-setting;
 &reference.sdo.entities.sdo-datafactory;
 &reference.sdo.entities.sdo-dataobject;
 &reference.sdo.entities.sdo-exception;
 &reference.sdo.entities.sdo-list;
 &reference.sdo.entities.sdo-model-property;
 &reference.sdo.entities.sdo-model-reflectiondataobject;
 &reference.sdo.entities.sdo-model-type;
 &reference.sdo.entities.sdo-sequence;
 
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->