docs/docs/SpatialFilter.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>MetacatUI Dev Docs: Class: SpatialFilter</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
    <link type="text/css" rel="stylesheet" href="styles/style.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: SpatialFilter</h1>

    
<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>SpatialFilter<span class="signature">()</span><span class="type-signature"></span></h2>
        
            <div class="class-description">SpatialFilter</div>
        

</header>

<article>
    <div class="container-overview">
    
        
    <h2>Constructor</h2>
    

    <h4 class="name" id="SpatialFilter"><span class="type-signature"></span>new SpatialFilter<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    A SpatialFilter represents a spatial constraint on the query to be executed,
and stores the geohash strings for all of the geohash tiles that coincide with the
search bounding box at the given zoom level.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_SpatialFilter.js.html">src/js/models/filters/SpatialFilter.js</a>, <a href="src_js_models_filters_SpatialFilter.js.html#line4">line 4</a>
    </li></ul></dd>
    

</dl>


    </div>

    
        <h3 class="subsection-title">Extends</h3>

        
    <ul>
        <li><a href="Filter.html">Filter</a></li>
    </ul>


        <h3 class="subsection-title">Members</h3>

        
<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>


<div class="description">
    The name of this Model
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="Filter.html#type">Filter#type</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_Filter.js.html">src/js/models/filters/Filter.js</a>, <a href="src_js_models_filters_Filter.js.html#line15">line 15</a>
    </li></ul></dd>
    

</dl>


        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id="defaults"><span class="type-signature"></span>defaults<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Inherits all default properties of <a href="Filter.html">Filter</a>
</div>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>geohashes</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">The array of geohashes used to spatially constrain the search</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>groupedGeohashes</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            </td>

            
            <td class="description last">The same geohash values, grouped by geohash level (e.g. 1,2,3...). Complete geohash groups (of 32) are consolidated to the level above.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>east</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">The easternmost longitude of the represented bounding box</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>west</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">The westernmost longitude of the represented bounding box</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>north</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">The northernmost latitude of the represented bounding box</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>south</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">The southernmost latitude of the represented bounding box</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>geohashLvel</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">The default precision level of the geohash-based search</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="Filter.html#defaults">Filter#defaults</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_SpatialFilter.js.html">src/js/models/filters/SpatialFilter.js</a>, <a href="src_js_models_filters_SpatialFilter.js.html#line31">line 31</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="escapeSpecialChar"><span class="type-signature"></span>escapeSpecialChar<span class="signature">(term)</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Escapes Solr query reserved characters so that search terms can include
 those characters without throwing an error.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>term</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The search term or phrase to escape</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Filter.html#escapeSpecialChar">Filter#escapeSpecialChar</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_Filter.js.html">src/js/models/filters/Filter.js</a>, <a href="src_js_models_filters_Filter.js.html#line406">line 406</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    - The search term or phrase, after special characters are escaped
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="getQuery"><span class="type-signature"></span>getQuery<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Builds a query string that represents this spatial filter
</div>


<dl class="details">

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="Filter.html#getQuery">Filter#getQuery</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_SpatialFilter.js.html">src/js/models/filters/SpatialFilter.js</a>, <a href="src_js_models_filters_SpatialFilter.js.html#line58">line 58</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    queryFragment - the query string representing the geohash constraints
</div>


    <h4 class="name" id="getValueQuerySubstring"><span class="type-signature"></span>getValueQuerySubstring<span class="signature">(values<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Constructs a query substring for each of the values set on this model
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>values</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">The values to use in this query substring.
If not provided, the values set on the model are used.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Filter.html#getValueQuerySubstring">Filter#getValueQuerySubstring</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_Filter.js.html">src/js/models/filters/Filter.js</a>, <a href="src_js_models_filters_Filter.js.html#line320">line 320</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The query substring
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h5>Example</h5>
    
    <pre class="prettyprint"><code>values: ["walker", "jones"]
  Returns: "(walker%20OR%20jones)"</code></pre>


    <h4 class="name" id="groupGeohashes"><span class="type-signature"></span>groupGeohashes<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Consolidates geohashes into groups based on their geohash level
 and updates the model with those groups. The fields and values attributes
 on this model are also updated with the geohashes.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_SpatialFilter.js.html">src/js/models/filters/SpatialFilter.js</a>, <a href="src_js_models_filters_SpatialFilter.js.html#line133">line 133</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="hasChangedValues"><span class="type-signature"></span>hasChangedValues<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Checks if this Filter has values different than the default values.
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Filter.html#hasChangedValues">Filter#hasChangedValues</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_Filter.js.html">src/js/models/filters/Filter.js</a>, <a href="src_js_models_filters_Filter.js.html#line393">line 393</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    - Returns true if this Filter has values set on it, otherwise will return false
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="initialize"><span class="type-signature"></span>initialize<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Initialize the model, calling super
</div>


<dl class="details">

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="Filter.html#initialize">Filter#initialize</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_SpatialFilter.js.html">src/js/models/filters/SpatialFilter.js</a>, <a href="src_js_models_filters_SpatialFilter.js.html#line50">line 50</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="isDateQuery"><span class="type-signature"></span>isDateQuery<span class="signature">(value)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Returns true if the given value or value set on this filter is a date range query
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The string to test</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Filter.html#isDateQuery">Filter#isDateQuery</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_Filter.js.html">src/js/models/filters/Filter.js</a>, <a href="src_js_models_filters_Filter.js.html#line592">line 592</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="parse"><span class="type-signature"></span>parse<span class="signature">(xml)</span><span class="type-signature"> &rarr; {JSON}</span></h4>
    

<div class="description">
    Parses the given XML node into a JSON object to be set on the model
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>xml</code></td>
            

            <td class="type">
            
                
<span class="param-type">Element</span>


            </td>

            
            <td class="description last">The XML element that contains all the filter elements</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Filter.html#parse">Filter#parse</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_Filter.js.html">src/js/models/filters/Filter.js</a>, <a href="src_js_models_filters_Filter.js.html#line98">line 98</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    - The JSON object of all the filter attributes
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">JSON</span>


    </dd>
</dl>

    
    <h4 class="name" id="parseFilterOptions"><span class="type-signature"></span>parseFilterOptions<span class="signature">(filterOptionsNode)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    Parses the filterOptions XML node into a literal object
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>filterOptionsNode</code></td>
            

            <td class="type">
            
                
<span class="param-type">Element</span>


            </td>

            
            <td class="description last">The filterOptions XML element to parse</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Filter.html#parseFilterOptions">Filter#parseFilterOptions</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_Filter.js.html">src/js/models/filters/Filter.js</a>, <a href="src_js_models_filters_Filter.js.html#line207">line 207</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    - The parsed filter options, in literal object form
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id="parseTextNode"><span class="type-signature"></span>parseTextNode<span class="signature">(parentNode, nodeName, isMultiple)</span><span class="type-signature"> &rarr; {string|Array}</span></h4>
    

<div class="description">
    Gets the text content of the XML node matching the given node name
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>parentNode</code></td>
            

            <td class="type">
            
                
<span class="param-type">Element</span>


            </td>

            
            <td class="description last">The parent node to select from</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>nodeName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The name of the XML node to parse</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>isMultiple</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
            <td class="description last">If true, parses the nodes into an array</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Filter.html#parseTextNode">Filter#parseTextNode</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_Filter.js.html">src/js/models/filters/Filter.js</a>, <a href="src_js_models_filters_Filter.js.html#line167">line 167</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    - Returns a string or array of strings of the text content
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>
|

<span class="param-type">Array</span>


    </dd>
</dl>

    
    <h4 class="name" id="resetValue"><span class="type-signature"></span>resetValue<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Resets the values attribute on this filter
</div>


<dl class="details">

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="Filter.html#resetValue">Filter#resetValue</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_Filter.js.html">src/js/models/filters/Filter.js</a>, <a href="src_js_models_filters_Filter.js.html#line385">line 385</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="updateDOM"><span class="type-signature"></span>updateDOM<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Element}</span></h4>
    

<div class="description">
    Updates XML DOM with the new values from the model
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">A literal object with options for this serialization</td>
        </tr>

    
    </tbody>
</table>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options.forCollection</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">If true, will create an XML DOM for Collection definitions, not FilterGroups</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="Filter.html#updateDOM">Filter#updateDOM</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_Filter.js.html">src/js/models/filters/Filter.js</a>, <a href="src_js_models_filters_Filter.js.html#line428">line 428</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    A new XML element with the updated values
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Element</span>


    </dd>
</dl>

    
    <h4 class="name" id="updateFilterOptionsDOM"><span class="type-signature"></span>updateFilterOptionsDOM<span class="signature">(filterOptionsNode<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Element}</span></h4>
    

<div class="description">
    Serializes the filter options into an XML DOM and returns it
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>filterOptionsNode</code></td>
            

            <td class="type">
            
                
<span class="param-type">Element</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">The XML filterOptions node to update</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Filter.html#updateFilterOptionsDOM">Filter#updateFilterOptionsDOM</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_Filter.js.html">src/js/models/filters/Filter.js</a>, <a href="src_js_models_filters_Filter.js.html#line521">line 521</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    - The updated DOM
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Element</span>


    </dd>
</dl>

    
    <h4 class="name" id="validate"><span class="type-signature"></span>validate<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
    

<div class="description">
    Checks if the values set on this model are valid.
Some of the attributes are changed during this process if they are found to be invalid,
since there aren't any easy ways for users to fix these issues themselves in the UI.
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Filter.html#validate">Filter#validate</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_js_models_filters_Filter.js.html">src/js/models/filters/Filter.js</a>, <a href="src_js_models_filters_Filter.js.html#line614">line 614</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    - Returns a literal object with the invalid attributes and their corresponding error message
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>

    
</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="AppConfig.html">AppConfig</a></li><li><a href="MetacatUI.html">MetacatUI</a></li></ul><h3>Classes</h3><ul><li><a href="AccessPolicy.html">AccessPolicy</a></li><li><a href="AccessPolicyView.html">AccessPolicyView</a></li><li><a href="AccessRule.html">AccessRule</a></li><li><a href="AppModel.html">AppModel</a></li><li><a href="AppView.html">AppView</a></li><li><a href="BooleanFilter.html">BooleanFilter</a></li><li><a href="ChoiceFilter.html">ChoiceFilter</a></li><li><a href="Citations.html">Citations</a></li><li><a href="CollectionModel.html">CollectionModel</a></li><li><a href="ColorPaletteView.html">ColorPaletteView</a></li><li><a href="DataCatalogView_drawTiles-TextOverlay.html">TextOverlay</a></li><li><a href="DataCatalogViewWithFilters.html">DataCatalogViewWithFilters</a></li><li><a href="DataItemView.html">DataItemView</a></li><li><a href="DataONEObject.html">DataONEObject</a></li><li><a href="DataPackage.html">DataPackage</a></li><li><a href="DateFilter.html">DateFilter</a></li><li><a href="DraftsView.html">DraftsView</a></li><li><a href="EditCollectionView.html">EditCollectionView</a></li><li><a href="EditorView.html">EditorView</a></li><li><a href="EML211.html">EML211</a></li><li><a href="EML211EditorView.html">EML211EditorView</a></li><li><a href="EMLEntity.html">EMLEntity</a></li><li><a href="EMLEntityView.html">EMLEntityView</a></li><li><a href="EMLGeoCoverage.html">EMLGeoCoverage</a></li><li><a href="EMlGeoCoverageView.html">EMlGeoCoverageView</a></li><li><a href="EMLNonNumericDomain.html">EMLNonNumericDomain</a></li><li><a href="EMLNumericDomain.html">EMLNumericDomain</a></li><li><a href="EMLPartyView.html">EMLPartyView</a></li><li><a href="EMLTemporalCoverage.html">EMLTemporalCoverage</a></li><li><a href="EMLView.html">EMLView</a></li><li><a href="Filter.html">Filter</a></li><li><a href="FilterGroup.html">FilterGroup</a></li><li><a href="FilterGroupsView.html">FilterGroupsView</a></li><li><a href="Filters.html">Filters</a></li><li><a href="ImageUploaderView.html">ImageUploaderView</a></li><li><a href="LookupModel.html">LookupModel</a></li><li><a href="MarkdownEditorView.html">MarkdownEditorView</a></li><li><a href="MarkdownView.html">MarkdownView</a></li><li><a href="MetadataView.html">MetadataView</a></li><li><a href="MetricModalView.html">MetricModalView</a></li><li><a href="NavbarView.html">NavbarView</a></li><li><a href="NumericFilter.html">NumericFilter</a></li><li><a href="ObjectFormats.html">ObjectFormats</a></li><li><a href="PortalDataView.html">PortalDataView</a></li><li><a href="PortalEditorView.html">PortalEditorView</a></li><li><a href="PortalListView.html">PortalListView</a></li><li><a href="PortalMembersView.html">PortalMembersView</a></li><li><a href="PortalModel.html">PortalModel</a></li><li><a href="PortalSectionView.html">PortalSectionView</a></li><li><a href="PortalView.html">PortalView</a></li><li><a href="PortEditorDataView.html">PortEditorDataView</a></li><li><a href="PortEditorImageView.html">PortEditorImageView</a></li><li><a href="PortEditorLogosView.html">PortEditorLogosView</a></li><li><a href="PortEditorMdSectionView.html">PortEditorMdSectionView</a></li><li><a href="PortEditorSectionsView.html">PortEditorSectionsView</a></li><li><a href="PortEditorSectionView.html">PortEditorSectionView</a></li><li><a href="PortEditorSettingsView.html">PortEditorSettingsView</a></li><li><a href="QualityReport.html">QualityReport</a></li><li><a href="RegisterCitationView.html">RegisterCitationView</a></li><li><a href="Search.html">Search</a></li><li><a href="SolrResultList.html">SolrResultList</a></li><li><a href="SpatialFilter.html">SpatialFilter</a></li><li><a href="Stats.html">Stats</a></li><li><a href="TableEditorView.html">TableEditorView</a></li><li><a href="ToggleFilter.html">ToggleFilter</a></li><li><a href="UIRouter.html">UIRouter</a></li><li><a href="UserView.html">UserView</a></li></ul><h3>Global</h3><ul><li><a href="global.html#appConfigPath">appConfigPath</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Aug 10 2020 17:22:17 GMT-0500 (Central Daylight Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>