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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 298830 $ -->
<phpdoc:classref xml:id="class.solrdocument" 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 SolrDocument class</title>
<titleabbrev>SolrDocument</titleabbrev>
<partintro>
<!-- {{{ SolrDocument intro -->
<section xml:id="solrdocument.intro">
&reftitle.intro;
<para>
Represents a Solr document retrieved from a query response.
</para>
</section>
<!-- }}} -->
<section xml:id="solrdocument.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SolrDocument</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<modifier>final</modifier>
<classname>SolrDocument</classname>
</ooclass>
<oointerface>
<interfacename>ArrayAccess</interfacename>
</oointerface>
<oointerface>
<interfacename>Iterator</interfacename>
</oointerface>
<oointerface>
<interfacename>Traversable</interfacename>
</oointerface>
<oointerface>
<interfacename>Serializable</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="solrdocument.constants.sort-default">SolrDocument::SORT_DEFAULT</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="solrdocument.constants.sort-asc">SolrDocument::SORT_ASC</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="solrdocument.constants.sort-desc">SolrDocument::SORT_DESC</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="solrdocument.constants.sort-field-name">SolrDocument::SORT_FIELD_NAME</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="solrdocument.constants.sort-field-value-count">SolrDocument::SORT_FIELD_VALUE_COUNT</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="solrdocument.constants.sort-field-boost-value">SolrDocument::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.solrdocument')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ SolrDocument constants -->
<section xml:id="solrdocument.constants">
&reftitle.constants;
<section xml:id="solrdocument.constants.types">
<title>SolrDocument Node Types</title>
<variablelist>
<varlistentry xml:id="solrdocument.constants.sort-default">
<term><constant>SolrDocument::SORT_DEFAULT</constant></term>
<listitem>
<para>Default mode for sorting fields within the document.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrdocument.constants.sort-asc">
<term><constant>SolrDocument::SORT_ASC</constant></term>
<listitem>
<para>Sorts the fields in ascending order</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrdocument.constants.sort-desc">
<term><constant>SolrDocument::SORT_DESC</constant></term>
<listitem>
<para>Sorts the fields in descending order</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrdocument.constants.sort-field-name">
<term><constant>SolrDocument::SORT_FIELD_NAME</constant></term>
<listitem>
<para>Sorts the fields by field name.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrdocument.constants.sort-field-value-count">
<term><constant>SolrDocument::SORT_FIELD_VALUE_COUNT</constant></term>
<listitem>
<para>Sorts the fields by number of values in each field.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrdocument.constants.sort-field-boost-value">
<term><constant>SolrDocument::SORT_FIELD_BOOST_VALUE</constant></term>
<listitem>
<para>Sorts the fields by thier boost values.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<!-- }}} -->
</partintro>
&reference.solr.entities.solrdocument;
</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
-->
|
