conf.js

Generic BBOP manager for dealing with gross GOlr configuration and management.

Contains bbop.golr.conf_field, bbop.golr.conf_class, and bbop.golr.conf.

TODO: better document all of this. Essentially, this is all for getting data out of a JSONized version of the YAML files used to drive the OWLTools-Solr parts of GOlr.

Summary

conf.js	Generic BBOP manager for dealing with gross GOlr configuration and management.
bbop.golr.conf_field
Functions
conf_field	Contructor for a GOlr search field.
display_name	The user-facing display name.
description	A longer description.
id	The unique ID of this profile.
searchable	Returns whether or not a string field has a shadow “*_searchable” field defined that is suitable for dismax searches.
required	Returns whether or not this field is required.
is_multi	Using the “cardinality” entry, returns whether or not this field is “single” (false) or “multi” (true).
is_fixed	Using the “property_type” entry, returns whether or not this field is “dynamic” (false) or “fixed” (true).
property	Returns the method of this field’s generation in the loader.
bbop.golr.conf_class
Functions
conf_class	Contructor for a GOlr search class.
display_name	The user-facing display name.
description	A longer description.
weight	The relative weight of this search class.
id	The unique ID of this profile.
document_category	The document category that this personality is meant to work with.
searchable_extension	This returns the searchable extension used for this class.
get_field	Returns a search field by id string.
get_fields	Return all of the fields in this search class.
get_weights	Get the various weights we need to run.
field_order_by_weight	Returns an array of field ids ordered by weight.
bbop.golr.conf
Functions
conf	Contructor for the GOlr query manager.
get_class	Returns a class info object by id string.
get_classes	Returns an array of all search classes.
get_classes_by_weight	Returns an array of all search classes.

bbop.golr.conf_field

Summary

Functions
conf_field	Contructor for a GOlr search field.
display_name	The user-facing display name.
description	A longer description.
id	The unique ID of this profile.
searchable	Returns whether or not a string field has a shadow “*_searchable” field defined that is suitable for dismax searches.
required	Returns whether or not this field is required.
is_multi	Using the “cardinality” entry, returns whether or not this field is “single” (false) or “multi” (true).
is_fixed	Using the “property_type” entry, returns whether or not this field is “dynamic” (false) or “fixed” (true).
property	Returns the method of this field’s generation in the loader.

Functions

conf_field

bbop.golr.conf_field = function ( field_conf_struct )

Contructor for a GOlr search field.

Arguments

field_conf_struct

JSONized config

Returns

conf_field object

display_name

this.display_name = function()

The user-facing display name. Suitable for label or title somewhere.

Returns

Display name string.

description

this.description = function()

A longer description. Suitable for tooltips.

Returns

Description string.

id

this.id = function()

The unique ID of this profile.

Returns

String.

searchable

this.searchable = function()

Returns whether or not a string field has a shadow “*_searchable” field defined that is suitable for dismax searches. Defaults to false.

Returns

boolean

required

this.required = function()

Returns whether or not this field is required. Defaults to false.

Not of particular use.

Returns

Boolean.

is_multi

this.is_multi = function()

Using the “cardinality” entry, returns whether or not this field is “single” (false) or “multi” (true). Defaults to false.

Returns

Boolean.

is_fixed

this.is_fixed = function()

Using the “property_type” entry, returns whether or not this field is “dynamic” (false) or “fixed” (true). Defaults to false.

Not of particular use.

Returns

Boolean.

property

this.property = function()

Returns the method of this field’s generation in the loader.

Not of particular use.

Returns

String.

bbop.golr.conf_class

Summary

Functions
conf_class	Contructor for a GOlr search class.
display_name	The user-facing display name.
description	A longer description.
weight	The relative weight of this search class.
id	The unique ID of this profile.
document_category	The document category that this personality is meant to work with.
searchable_extension	This returns the searchable extension used for this class.
get_field	Returns a search field by id string.
get_fields	Return all of the fields in this search class.
get_weights	Get the various weights we need to run.
field_order_by_weight	Returns an array of field ids ordered by weight.

Functions

conf_class

bbop.golr.conf_class = function ( class_conf_struct )

Contructor for a GOlr search class.

Arguments

class_conf_struct

JSONized config

Returns

conf_class object

display_name

this.display_name = function()

The user-facing display name. Suitable for label or title somewhere.

Returns

Display name string.

description

this.description = function()

A longer description. Suitable for tooltips.

Returns

Description string.

weight

this.weight = function()

The relative weight of this search class.

Returns

Integer.

id

this.id = function()

The unique ID of this profile.

Returns

String.

document_category

this.document_category = function()

The document category that this personality is meant to work with. Otherwise, returns the class id.

Returns

String.

searchable_extension

this.searchable_extension = function()

This returns the searchable extension used for this class. There is a typical default, but it might be change in namespace collisions, so it’s better to just use this.

Parameters

n/a

Returns

string

get_field

this.get_field = function( fid )

Returns a search field by id string. Null otherwise.

Parameters

fid	a string id for the field

Returns

bbop.golr.conf_field

get_fields

this.get_fields = function()

Return all of the fields in this search class.

Returns

Array of bbop.golr.conf_field (unordered).

get_weights

this.get_weights = function( weight_category )

Get the various weights we need to run.

The weight category can be ‘boost’, ‘result’, or ‘filter’.

Arguments

weight_category

string identifying the legal weight category

Returns

object of {field => weight, ...}

field_order_by_weight

this.field_order_by_weight = function( weight_category,
cutoff )

Returns an array of field ids ordered by weight.

The weight category can be ‘boost’, ‘result’, or ‘filter’.

Arguments

weight_category	string identifying the legal weight category
cutoff	[optional] if not defined, all listed fields in set returned

Returns

array like [field5, field4, ...]

bbop.golr.conf

Summary

Functions
conf	Contructor for the GOlr query manager.
get_class	Returns a class info object by id string.
get_classes	Returns an array of all search classes.
get_classes_by_weight	Returns an array of all search classes.

Functions

conf

bbop.golr.conf = function ( golr_conf_var )

Contructor for the GOlr query manager. Why don’t we just take bbop.golr.golr_meta as read? We want to leave the door open to having multiple GOlrs running in the same area.

Arguments

golr_conf_var

JSized GOlr config

Returns

golr conf object

get_class

this.get_class = function( fid )

Returns a class info object by id string. Null otherwise.

Arguments

fid

TODO

Returns

bbop.golr.conf_class.

get_classes

this.get_classes = function()

Returns an array of all search classes.

Returns

Array of bbop.golr.conf_class (unordered).

get_classes_by_weight

this.get_classes_by_weight = function()

Returns an array of all search classes. Ordered by weight.

Returns

Array of bbop.golr.conf_class.