File: solrinputdocument.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (160 lines) | stat: -rw-r--r-- 5,260 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 298830 $ -->

<phpdoc:classref xml:id="class.solrinputdocument" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The SolrInputDocument class</title>
 <titleabbrev>SolrInputDocument</titleabbrev>

 <partintro>

<!-- {{{ SolrInputDocument intro -->
  <section xml:id="solrinputdocument.intro">
   &reftitle.intro;
   <para>
    This class represents a Solr document that is about to be submitted to the Solr index.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="solrinputdocument.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>SolrInputDocument</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <modifier>final</modifier>
      <classname>SolrInputDocument</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="solrinputdocument.constants.sort-default">SolrInputDocument::SORT_DEFAULT</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="solrinputdocument.constants.sort-asc">SolrInputDocument::SORT_ASC</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="solrinputdocument.constants.sort-desc">SolrInputDocument::SORT_DESC</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="solrinputdocument.constants.sort-field-name">SolrInputDocument::SORT_FIELD_NAME</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="solrinputdocument.constants.sort-field-value-count">SolrInputDocument::SORT_FIELD_VALUE_COUNT</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="solrinputdocument.constants.sort-field-boost-value">SolrInputDocument::SORT_FIELD_BOOST_VALUE</varname>
     <initializer>4</initializer>
    </fieldsynopsis>
    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrinputdocument')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
   </classsynopsis>
<!-- }}} -->

  </section>
  
<!-- {{{ SolrInputDocument constants -->
  <section xml:id="solrinputdocument.constants">
   &reftitle.constants;
   <section xml:id="solrinputdocument.constants.types">
    <title>SolrInputDocument Class Constants</title>
    <variablelist>

     <varlistentry xml:id="solrinputdocument.constants.sort-default">
      <term><constant>SolrInputDocument::SORT_DEFAULT</constant></term>
      <listitem>
       <para>Sorts the fields in ascending order.</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="solrinputdocument.constants.sort-asc">
      <term><constant>SolrInputDocument::SORT_ASC</constant></term>
      <listitem>
       <para>Sorts the fields in ascending order.</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="solrinputdocument.constants.sort-desc">
      <term><constant>SolrInputDocument::SORT_DESC</constant></term>
      <listitem>
       <para>Sorts the fields in descending order.</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="solrinputdocument.constants.sort-field-name">
      <term><constant>SolrInputDocument::SORT_FIELD_NAME</constant></term>
      <listitem>
       <para>Sorts the fields by name</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="solrinputdocument.constants.sort-field-value-count">
      <term><constant>SolrInputDocument::SORT_FIELD_VALUE_COUNT</constant></term>
      <listitem>
       <para>Sorts the fields by number of values.</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="solrinputdocument.constants.sort-field-boost-value">
      <term><constant>SolrInputDocument::SORT_FIELD_BOOST_VALUE</constant></term>
      <listitem>
       <para>Sorts the fields by boost value.</para>
      </listitem>
     </varlistentry>

    </variablelist>
   </section>
  </section>
<!-- }}} -->


 </partintro>

 &reference.solr.entities.solrinputdocument;

</phpdoc:classref>

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