File: SolrCollapseFunction.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (109 lines) | stat: -rw-r--r-- 4,520 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SolrCollapseFunction" namespace="" name="SolrCollapseFunction">
  <constant name="NULLPOLICY_IGNORE" value="ignore">
    <docblock>
      <var type="string"/>
    </docblock>
  </constant>
  <constant name="NULLPOLICY_EXPAND" value="expand">
    <docblock>
      <var type="string"/>
    </docblock>
  </constant>
  <constant name="NULLPOLICY_COLLAPSE" value="collapse">
    <docblock>
      <var type="string"/>
    </docblock>
  </constant>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructor"/>
      <return type="void"/>
    </docblock>
    <parameter name="field" optional="true" byreference="false" type="string"/>
  </constructor>
  <method name="getField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the field that is being collapsed on"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getHint" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns collapse hint"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getMax" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns max parameter"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getMin" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns min parameter"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getNullPolicy" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns null policy"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getSize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns size parameter"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="setField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the field to collapse on"/>
      <return type="SolrCollapseFunction"/>
    </docblock>
    <parameter name="fieldName" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setHint" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets collapse hint"/>
      <return type="SolrCollapseFunction"/>
    </docblock>
    <parameter name="hint" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setMax" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Selects the group heads by the max value of a numeric field or function query"/>
      <return type="SolrCollapseFunction"/>
    </docblock>
    <parameter name="max" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setMin" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the initial size of the collapse data structures when collapsing on a numeric field only"/>
      <return type="SolrCollapseFunction"/>
    </docblock>
    <parameter name="min" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setNullPolicy" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the NULL Policy"/>
      <return type="SolrCollapseFunction"/>
    </docblock>
    <parameter name="nullPolicy" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setSize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the initial size of the collapse data structures when collapsing on a numeric field only"/>
      <return type="SolrCollapseFunction"/>
    </docblock>
    <parameter name="size" optional="false" byreference="false" type="int"/>
  </method>
  <method name="__toString" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns a string representing the constructed collapse function"/>
      <return type="string"/>
    </docblock>
  </method>
</class>