archived-doc-es/reference/swish/classes.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5c20ff9960166638320c32da9004e1b30ec6e9f0 Maintainer: jesusruiz Status: ready -->
<section xml:id="swish.classes" xmlns="http://docbook.org/ns/docbook">
 &reftitle.classes;
  <section>
   &reftitle.classes;
   <section xml:id="swish.class.swish">
    <title><classname>Swish</classname></title>
    <para>
    </para>
    <section xml:id="swish.class.swish.properties">
     &reftitle.properties;
     <itemizedlist>
      <listitem>
       <para>
        <property>indexes</property> - el array de índices utilizados y sus propiedades. Cierta
        lista de propiedades dependen de la versión Swish-e.
       </para>
      </listitem>
     </itemizedlist>
    </section>
    <section xml:id="swish.class.swish.methods">
     &reftitle.methods;
     <itemizedlist>
      <listitem>
       <para>
        <xref linkend="swish.construct" /> - construye un nuevo objeto
        <classname>Swish</classname>. 
        Lanza <classname>SwishException</classname> en caso de error.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swish.prepare" /> - confecciona y devuelve
        un objeto <classname>SwishSearch</classname>.
        Lanza <classname>SwishException</classname> en caso de error.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swish.query" /> - ejecuta la consulta y
        devuelve un objeto <classname>SwishResults</classname>.
        Lanza <classname>SwishException</classname> en caso de error.
       </para>
      </listitem>
      <listitem>
       <para><xref linkend="swish.getmetalist" /> - devuelve un array
       de entradas de metadatos para el archivo índice dado.</para>
      </listitem>
      <listitem>
       <para><xref linkend="swish.getpropertylist" /> - devuelve un array
       de propiedades para el archivo índice dado.</para>
      </listitem>
     </itemizedlist>
    </section>
   </section>
   <section xml:id="swish.class.swishsearch">
    <title><classname>SwishSearch</classname></title>
    <para>
    </para>
    <section xml:id="swish.class.swishsearch.methods">
     &reftitle.methods;
     <itemizedlist>
      <listitem>
       <para>
        <xref linkend="swishsearch.setstructure" /> - establece el indicador de
        estructura en el objeto de la búsqueda. Este indicador de estructura se utiliza para limitar la búsqueda
        a determinadas partes de los documentos HTML.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishsearch.setphrasedelimiter" /> - establece
        el carácter delimitador de frase. El delimitador por defecto es comillas dobles.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishsearch.setsort" /> - establece el tipo
        de ordenación de los resultados.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishsearch.setlimit" /> - establece los límites
        para la búsqueda.
        Lanza <classname>SwishException</classname> en caso de error.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishsearch.resetlimit" /> - restablece los
        límites.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishsearch.execute" /> - ejecuta la
        consulta y devuelve un objeto <classname>SwishResults</classname>.
        Lanza <classname>SwishException</classname> en caso de error.
       </para>
      </listitem>
     </itemizedlist>
    </section>
   </section>
   <section xml:id="swish.class.swishresults">
    <title><classname>SwishResults</classname></title>
    <para>
    </para>
    <section xml:id="swish.class.swishresults.properties">
     &reftitle.properties;
     <itemizedlist>
      <listitem>
       <para>
        <property>hits</property> - el número de coincidencias en este
        objeto <classname>SwishResults</classname>.
       </para>
      </listitem>
      <listitem>
       <para>
        <property>indexes</property> - el array de índices utilizados en la búsqueda.
       </para>
      </listitem>
     </itemizedlist>
    </section>
    <section xml:id="swish.class.swishresults.methods">
     &reftitle.methods;
     <itemizedlist>
      <listitem>
       <para>
        <xref linkend="swishresults.nextresult" /> - devuelve el
        siguiente objeto <classname>SwishResult</classname> o &false; si no hay
        más resultados disponibles.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishresults.seekresult" /> - establece la
        posición de búsqueda actual en el objeto <classname>SwishResults</classname>
        Lanza <classname>SwishException</classname> en caso de error.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishresults.getparsedwords" /> -
        devuelve un array de palabras en la consulta con palabras irrelevantes eliminadas.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishresults.getremovedstopwords" /> -
        devuelve un array de palabras irrelevantes eliminadas.
       </para>
      </listitem>
     </itemizedlist>
    </section>
   </section>
   <section xml:id="swish.class.swishresult">
    <title><classname>SwishResult</classname></title>
    <para>
    </para>
    <section xml:id="swish.class.swishresult.properties">
     &reftitle.properties;
     <itemizedlist>
      <listitem>
       <para>Lista de propiedades depende de la versión Swish-e, vea los ejemplos.</para>
      </listitem>
     </itemizedlist>
    </section>
    <section xml:id="swish.class.swishresult.methods">
     &reftitle.methods;
     <itemizedlist>
      <listitem>
       <para>
        <xref linkend="swishresult.getmetalist" /> - devuelve
        un array de entradas de meta para el índice utilizado en este resultado.
       </para>
      </listitem>
      <listitem>
       <para>
        <xref linkend="swishresult.stem" /> - Reduce la palabra a su ráiz
        y devuelve resultado como un array de cadenas.
        Lanza <classname>SwishException</classname> en caso de error.
       </para>
      </listitem>
     </itemizedlist>
    </section>
   </section>
   <section xml:id="swish.class.swishexception">
    <title><classname>SwishException</classname></title>
    <para>
     <classname>SwishException</classname> extiende el constructor en
     clase <classname>Exception</classname> y posee el mismo conjunto de
     propiedades y métodos. Vea <xref
      linkend="language.exceptions.extending"/> para conocer más detalles.
    </para>
   </section>
  </section>
</section>

<!-- 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
-->