Get schema.
The expected return is SOIF instances, first of an RDM
header then of a schema. The RDM header is checked for
status and, if it exists, the remaining SOIF is converted
into a schema data structure. Once all this is completed,
the thread terminates and the schema can be requested by
calling getSchema().
An additional bit of prep that can be done by the SchemaGetter
is the "disappear" business. This calls a method that goes
through the schema and sets a flag on each attribute depending
on whether that attribute is searchable or not.
Currently, only indexed attributes are searchable.
Note:
The RDMHeader class is not currently used to formulate requests.
This may change.
Both SchemaGetter and TaxonomyGetter initialize
their RDM header strings with a correct RDM request.
Because there are other schema and taxonomy requests that can be
made which are currently not well (or not at all) documented
the standard request can be changed using setRDMHeader()
which allows you to put in anything but prevents you from changing
the request during processing (the scope of the processing
phase far exceeds the requirement for safe operation).
The setRDMHeader() method should be used with the
understanding that the interface will very likely change.
It is also possible that the constructors will change,
but the most likely scenario is that RDMHeader savvy
constructors will be added.
|