Semantic MediaWiki and related extensions
|
Public Member Functions | |
getDIType () | |
getSortKey () | |
equals (SMWDataItem $di) | |
getSortKeyDataItem () | |
getSerialization () | |
getSha1 () | |
getHash () | |
__toString () | |
setOption ( $key, $value) | |
getOption ( $key, $default=null) | |
Static Public Member Functions | |
static | newFromSerialization ( $diType, $serialization) |
static | getDataItemClassNameForId ( $diType) |
Public Attributes | |
const | TYPE_NOTYPE = 0 |
Data item ID that can be used to indicate that no data item class is appropriate. | |
const | TYPE_NUMBER = 1 |
Data item ID for SMWDINumber. | |
const | TYPE_BLOB = 2 |
Data item ID for SMWDIBlob. | |
const | TYPE_BOOLEAN = 4 |
Data item ID for SMWDIBoolean. | |
const | TYPE_URI = 5 |
Data item ID for SMWDIUri. | |
const | TYPE_TIME = 6 |
Data item ID for SMWDITimePoint. | |
const | TYPE_GEO = 7 |
Data item ID for SMWDIGeoCoord. | |
const | TYPE_CONTAINER = 8 |
Data item ID for SMWDIContainer. | |
const | TYPE_WIKIPAGE = 9 |
Data item ID for SMWDIWikiPage. | |
const | TYPE_CONCEPT = 10 |
Data item ID for SMWDIConcept. | |
const | TYPE_PROPERTY = 11 |
Data item ID for SMWDIProperty. | |
const | TYPE_ERROR = 12 |
Data item ID for SMWDIError. | |
Objects of this type represent all that is known about a certain piece of data that could act as the value of some property. Data items only represent the stored data, and are thus at the core of SMW's data model. Data items are always immutable, i.e. they must not be changed after creation (and this is mostly enforced by the API with some minor exceptions).
The set of available data items is fixed and cannot be extended. These are the kinds of information that SMW can process. Their concrete use and handling might depend on the context in which they are used. In particular, property values may be influences by settings made for their property. This aspect, however, is not part of the data item API.
SMWDataItem::__toString | ( | ) |
|
abstract |
Method to compare two SMWDataItems This should result true only if they are of the same DI type and have the same internal value
SMWDataItem | $di |
|
static |
Gets the class name of the data item that has the provided type id.
integer | $diType | Element of the SMWDataItem::TYPE_ enum |
InvalidArgumentException |
|
abstract |
Convenience method that returns a constant that defines the concrete class that implements this data item. Used to switch when processing data items.
SMWDataItem::getHash | ( | ) |
Get a hash string for this data item. Might be overwritten in subclasses to obtain shorter or more efficient hashes.
SMWDataItem::getOption | ( | $key, | |
$default = null |
|||
) |
string | $key | |
string | null | $default |
|
abstract |
Get a UTF-8 encoded string serialization of this data item. The serialisation should be concise and need not be pretty, but it must allow unserialization. Each subclass of SMWDataItem implements a static method doUnserialize() for this purpose.
SMWDataItem::getSha1 | ( | ) |
|
abstract |
Return a value that can be used for sorting data of this type. If the data is of a numerical type, the sorting must be done in numerical order. If the data is a string, the data must be sorted alphabetically.
SMWDataItem::getSortKeyDataItem | ( | ) |
Create a data item that represents the sortkey, i.e. either an SMWDIBlob or an SMWDINumber. For efficiency, these subclasses overwrite this method to return themselves.
|
static |
Create a data item of the given dataitem ID based on the the provided serialization string and (optional) typeid.
integer | $diType | dataitem ID |
string | $serialization |
SMWDataItem::setOption | ( | $key, | |
$value | |||
) |
string | $key | |
string | $value |