blob: 5e5a0ffcae3dee950630abf68cc8247401c9127c (
plain)
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
<?php
namespace SMW\Query\Language;
use SMW\Query\Exception\FingerprintNotFoundException;
use SMW\Query\PrintRequest;
/**
* Abstract base class for all descriptions
*
* @license GNU GPL v2+
* @since 1.6
*
* @author Markus Krötzsch
*/
abstract class Description {
/**
* @var PrintRequest[]
*/
protected $m_printreqs = [];
/**
* @var string|null
*/
protected $fingerprint = null;
/**
* @var string
*/
private $membership = '';
/**
* Get the (possibly empty) array of all print requests that
* exist for the entities that fit this description.
*
* @return PrintRequest[]
*/
public function getPrintRequests() {
return $this->m_printreqs;
}
/**
* Set the array of print requests completely.
*
* @param PrintRequest[] $printRequests
*/
public function setPrintRequests( array $printRequests ) {
$this->m_printreqs = $printRequests;
}
/**
* Add a single SMW\Query\PrintRequest.
*
* @param PrintRequest $printRequest
*/
public function addPrintRequest( PrintRequest $printRequest ) {
$this->m_printreqs[] = $printRequest;
}
/**
* Add a new print request, but at the beginning of the list of requests
* (thus it will be printed first).
*
* @param PrintRequest $printRequest
*/
public function prependPrintRequest( PrintRequest $printRequest ) {
array_unshift( $this->m_printreqs, $printRequest );
}
/**
* Returns a compound signature that identifies the canonized
* description. It builds a fingerrint so that [[Foo::123]][[Bar::abc]]
* returns the same signature as for [[Bar::abc]][[Foo::123]].
*
* @note An extension to a description should not rely on the query string
* as sole representation for a fingerprint.
*
* @since 2.5
*
* @return string
* @throws FingerprintNotFoundException
*/
public function getFingerprint() {
if ( $this->fingerprint !== null ) {
return $this->fingerprint;
}
throw new FingerprintNotFoundException( "Missing a fingerprint, a signature was expected for the current description instance." );
}
/**
* Identifies an arbitrary membership to a wider circle of descriptions that
* mostly occurs in connection with a Conjunction, Disjunction, or
* SomeProperty.
*
* @since 2.5
*
* @return string
*/
public function getMembership() {
return $this->membership;
}
/**
* @since 2.5
*
* @param string $membership
*/
public function setMembership( $membership ) {
$this->membership = $membership;
}
/**
* Return a string expressing this query.
* Some descriptions have different syntax in property value positions. The
* parameter $asvalue specifies whether the serialisation should take that into
* account.
*
* Example: The SMWValueDescription [[Paris]] returns the single result "Paris"
* but can also be used as value in [[has location::Paris]] which is preferred
* over the canonical [[has location::\<q\>[[Paris]]\</q\>]].
*
* The result should be a plain query string that SMW is able to parse,
* without any kind of HTML escape sequences.
*
* @param boolean $asValue
*
* @return string
*/
abstract public function getQueryString( $asValue = false );
/**
* Return true if the description is required to encompass at most a single
* result, independently of the knowledge base.
*
* @return boolean
*/
abstract public function isSingleton();
/**
* Compute the size of the description. Default is 1.
*
* @return integer
*/
public function getSize() {
return 1;
}
/**
* Compute the depth of the description. Default is 0.
*
* @return integer
*/
public function getDepth() {
return 0;
}
/**
* Report on query features used in description. Return values are (sums of)
* query feature constants such as SMW_PROPERTY_QUERY.
*/
public function getQueryFeatures() {
return 0;
}
/**
* Recursively restrict query to a maximal size and depth as given.
* Returns a possibly changed description that should be used as a replacement.
* Reduce values of parameters to account for the returned descriptions size.
* Default implementation for non-nested descriptions of size 1.
* The parameter $log contains a list of all pruned conditions, updated when some
* description was reduced.
*
* @note Objects must not do changes on $this during pruning, since $this can be
* reused in multiple places of one or many queries. Make new objects to reflect
* changes!
*/
public function prune( &$maxsize, &$maxDepth, &$log ) {
if ( ( $maxsize < $this->getSize() ) || ( $maxDepth < $this->getDepth() ) ) {
$log[] = $this->getQueryString();
$result = new ThingDescription();
$result->setPrintRequests( $this->getPrintRequests() );
return $result;
}
$maxsize = $maxsize - $this->getSize();
$maxDepth = $maxDepth - $this->getDepth();
return $this;
}
/**
* @since 3.0
*
* @return string
*/
public function __toString() {
return $this->getQueryString();
}
}
|
