* listing all relevant settings is preferred. */ public function viewSettings(); /** * Get importer Id */ public function getImporterId(); /** * @param array of MicaDatasetQueryTerm $terms */ public function query(array $terms); /** * @param array of MicaDatasetQueryTerm $terms * @param array of strings $fields */ public function queryBy(array $terms, array $fields); /** * Returns a facet for a specific term. * * Categorical variables will return an associative array: * array('YES' => 3000, 'NO' => 50000) * * Continuous variables will return statistics (min, max, mean, variance,std_deviation,count,total,sum_of_squares) * array( * 'min' => 10.45, * 'max' => 23.78, * ... * ) */ public function facetTerm(QueryTermInterface $term); } /** * Abstract class with generic implementation of most connection methods. */ abstract class MicaDatasetAbstractConnection implements MicaDatasetConnectionInterface { /** * @var MicaDatasetConnector */ protected $connector; /** * Direct reference to the connector's $options property. * * @var array */ protected $options = array(); /** * Constructor for a connection class, setting the connector configuration used with * this connection. * * The default implementation sets $this->connector and $this->options. * * @param MicaDatasetConnector $connector * The connector object for this connection. */ public function __construct(MicaDatasetConnector $connector) { $this->connector = $connector; $this->options = &$connector->options; } /** * Form callback. Might be called on an uninitialized object - in this case, * the form is for configuring a newly created connector. * * Returns an empty form by default. * * @return array * A form array for setting connection-specific options. */ public function configurationForm($study_node) { return array(); } /** * Validation callback for the form returned by configurationForm(). * * Does nothing by default. * * @param array $form * The form returned by configurationForm(). * @param array $values * The part of the $form_state['values'] array corresponding to this form. * @param array $form_state * The complete form state. */ public function configurationFormValidate(array $form, array &$values, array &$form_state) { return; } /** * Submit callback for the form returned by configurationForm(). * * The default implementation just ensures that additional elements in * $options, not present in the form, don't get lost at the update. * * @param array $form * The form returned by configurationForm(). * @param array $values * The part of the $form_state['values'] array corresponding to this form. * @param array $form_state * The complete form state. */ public function configurationFormSubmit(array $form, array &$values, array &$form_state) { if (!empty($this->options)) { $values += $this->options; } $this->options = $values; } /** * Determines whether this connection class implementation supports a given * feature. Features are optional extensions to Search API functionality and * usually defined and used by third-party modules. * * @param string $feature * The name of the optional feature. * * @return boolean * TRUE if this connection knows and supports the specified feature. FALSE * otherwise. */ public function supportsFeature($feature) { return FALSE; } /** * View this connector's settings. Output can be HTML or a render array, a

' . check_plain($name) . ': ' . nl2br(check_plain(print_r($value, TRUE))) . '