Store Field Predicate Map

Field Predicate Maps provide the ability to configure a mapping from RDF predicates to short names in order to configure the full text search functionality. The mapping can also specific analyzers that are applied to the predicates in order to configure how text is indexed.

Note that at present, only properties listed in a store's Field Predicate Map are indexed. So the mapping must be updated to ensure that all fields are properly indexed. In addition, only literal values will be indexed.

URI Pattern

Note: Currently the platform supports only a single Field Predicate Map for each store. This is at the well-known location shown below.

http://api.talis.com/stores/{storename}/config/fpmaps/1

The Field Predicate Map for older Stores may be found at a different location. You may also want to try

http://api.talis.com/stores/mystore/indexes/default/fpmaps/default
http://api.talis.com/stores/mystore/indexes/metaboxIndex/fpmaps/fpmap
http://api.talis.com/stores/mystore/indexes/m21Advanced/fpmaps/fpmap

If none of those work, please contact us and we'll look it up for you.

Resource Operations

URI Pattern	Method	Request Body	Semantics	Capability required
`/config/fpmaps/1`	GET		retrieve the mappings	configure store
	PUT	`application/rdf+xml`	update the mappings	configure store

Request Parameters

Parameter	Required?	Description	Values
`output`	No	Specify the Output Type. For GET only.	`rdf` `xml` `html` `xhtml`

Retrieve The Mappings

A GET request to the Field Predicate Map URI will retrieve the current mapping configuration. Performing this operations requires the configure store capability.

The response is an RDF/XML document, e.g:

<?xml version="1.0" encoding="utf-8"?>
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" 
 xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" 
 xmlns:bf="http://schemas.talis.com/2006/bigfoot/configuration#" 
 xmlns:frm="http://schemas.talis.com/2006/frame/schema#" >
  <bf:FieldPredicateMap rdf:about="http://api.talis.com/stores/mystore/indexes/default/fpmaps/default">
    <frm:mappedDatatypeProperty>
      <rdf:Description rdf:about="http://api.talis.com/stores/mystore/indexes/default/fpmaps/default#name">
        <frm:property rdf:resource="http://xmlns.com/foaf/0.1/name"/>
        <frm:name>name</frm:name>
      </rdf:Description>
    </frm:mappedDatatypeProperty>
  </bf:FieldPredicateMap>
</rdf:RDF>

Alternate representations can be retrieved using the output parameter or the Accept header.

For a description of this format and further information see the Field Predicate Map documentation.

The retrieved RDF consists of the Hierarchical CBD for the requested resource.

Update The Mappings

The mappings for a Store can be updated by performing a PUT request to the mapping URI, submitting a complete description of the mapping configuration. The document in the PUT request will be used to completely replace the current configuration with that specified.

Care should therefore be taken to ensure that a current copy of the configuration is retrieved, updated locally, and then submitted back to the server to apply the changes. Any mapping configuration that is not included in the data PUT back to the server will be deleted.

Comments

	Search this site