<!DOCTYPE html>

<html lang="en">
<head>
	<meta charset="utf-8">
	<title>Documentation Module: DBConnector</title>

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

	<link type="text/css" rel="stylesheet" href="styles/site.flatly.css">

</head>

<body>
<div class="container-fluid">
	<div class="navbar navbar-fixed-top ">
		<div class="navbar-inner">
			<a class="brand" href="index.html">Documentation</a>
			<ul class="nav">
				
				<li class="dropdown">
					<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b
						class="caret"></b></a>

					<ul class="dropdown-menu ">
						
						<li>
							<a href="module-Dashboard.html">Dashboard</a>
						</li>
						
						<li>
							<a href="module-DBConnector.html">DBConnector</a>
						</li>
						
						<li>
							<a href="module-MessageCenter.html">MessageCenter</a>
						</li>
						
						<li>
							<a href="module-Mocks.html">Mocks</a>
						</li>
						
						<li>
							<a href="module-Widget.html">Widget</a>
						</li>
						
						<li>
							<a href="module-WidgetMap.html">WidgetMap</a>
						</li>
						

					</ul>
				</li>
				
				<li class="dropdown">
					<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
						class="caret"></b></a>

					<ul class="dropdown-menu ">
						
						<li>
							<a href="module-Dashboard-Dashboard.html">Dashboard</a>
						</li>
						
						<li>
							<a href="module-Widget-Widget.html">Widget</a>
						</li>
						

					</ul>
				</li>
				
			</ul>
		</div>
	</div>

	<div class="row-fluid">

		
		<div class="span8">
			
				<div id="main">
					


	<h1 class="page-title">Module: DBConnector</h1>
<section>

<header>
    <h2>
    DBConnector
    </h2>
    
</header>

<article>
    <div class="container-overview">
    

    
        
            <div class="description">Database connector module<br>
Implements ajax data fetching from Cache back-end</div>
        

        
<dl class="details">
	

	

	

	

	

	

	

	

	



	

	

	

	
</dl>


        
    
    </div>

    

    

    

    

    

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

        <dl>
            
<dt>
    <h4 class="name" id="defaults"><span class="type-signature">&lt;private> </span>defaults<code><span class="type-signature"> :Object</span></code></h4>
    
    
</dt>
<dd>
    
    <div class="description">
        Default settings for DBConnector
    </div>
    
    
    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Object</span>


            </li>
        </ul>
    

    
<dl class="details">
	

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

	<dl>

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

		<th>Type</th>

		

		

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

	<tbody>
	

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

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


            
            </td>

            

            

            <td class="description last">Username to connect to DB</td>
        </tr>

	

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

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


            
            </td>

            

            

            <td class="description last">Password to connect to DB</td>
        </tr>

	
	</tbody>
</table>
</dl>

	

	

	

	

	

	

	

	

	



	

	

	

	
</dl>

    
    
</dd>

        </dl>
    

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

        <table class="table table-stripped">
            
<tr>
    <td>
    <h4 class="name" id="acquireData"><span class="type-signature"></span>acquireData<span class="signature">()</span><span class="type-signature"></span></h4>
    
    
    </td>
<td>
    
    
    <div class="description">
        Does ajax request for data from server
    </div>
    

    
    
    
    
    
    
    
<dl class="details">
	

	

	

	

	

	

	

	

	



	

	

	

	
</dl>

    
    
    <h5>Fires:</h5>
    <ul>
        <li>module:MessageCenter#event:*_data_acquired</li>
    </ul>
    

    
    <h5>Listens to Events:</h5>
    <ul>
        <li>module:MessageCenter#event:data_requested</li>
    </ul>
    

    
    
    
    
    
    
    
    </td>
</tr>

        
            
<tr>
    <td>
    <h4 class="name" id="acquireFilters"><span class="type-signature"></span>acquireFilters<span class="signature">()</span><span class="type-signature"></span></h4>
    
    
    </td>
<td>
    
    
    <div class="description">
        Acquires filter list for cube from server
    </div>
    

    
    
    
    
    
    
    
<dl class="details">
	

	

	

	

	

	

	

	

	



	

	

	

	
</dl>

    
    
    <h5>Fires:</h5>
    <ul>
        <li>module:MessageCenter#event:filters_acquired</li>
    </ul>
    

    
    <h5>Listens to Events:</h5>
    <ul>
        <li>module:MessageCenter#event:filters_requested</li>
    </ul>
    

    
    
    
    
    
    
    
    </td>
</tr>

        
            
<tr>
    <td>
    <h4 class="name" id="acquireFilterValues"><span class="type-signature"></span>acquireFilterValues<span class="signature">()</span><span class="type-signature"></span></h4>
    
    
    </td>
<td>
    
    
    <div class="description">
        Acquire possible values for selected filter
    </div>
    

    
    
    
    
    
    
    
<dl class="details">
	

	

	

	

	

	

	

	

	



	

	

	

	
</dl>

    
    
    <h5>Fires:</h5>
    <ul>
        <li>module:MessageCenter#event:filter_list_acquired[path]</li>
    </ul>
    

    
    <h5>Listens to Events:</h5>
    <ul>
        <li>module:MessageCenter#event:filter_list_requested</li>
    </ul>
    

    
    
    
    
    
    
    
    </td>
</tr>

        
            
<tr>
    <td>
    <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
    
    
    </td>
<td>
    
    

    
    
    
    
    
    
    
<dl class="details">
	

	

	

	

	

	

	

	

	



	

	

	

	
</dl>

    
    

    

    
    
    
    
    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    Module name
</div>



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


	</dd>
</dl>


        
    
    
    </td>
</tr>

        </table>
    

    

    
</article>

</section>




				</div>

				<div class="clearfix"></div>
				<footer>
					
					
		<span class="jsdoc-message">
		Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha8</a>
		on 2014-09-11T04:54:51+04:00 using the <a
			href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
		</span>
				</footer>
			</div>

			
			<div class="span3">
				<div id="toc"></div>
			</div>
			
			<br clear="both">
		</div>

	</div>
	<!--<script src="scripts/sunlight.js"></script>-->
	<script src="scripts/docstrap.lib.js"></script>
	<script src="scripts/bootstrap-dropdown.js"></script>
	<script src="scripts/toc.js"></script>

	<script>
		$( function () {
			$( "#toc" ).toc( {
				anchorName  : function ( i, heading, prefix ) {
					return $( heading ).attr( "id" ) || ( prefix + i );
				},
				selectors   : "h1,h2,h3,h4",
				showAndHide : false,
				scrollTo    : 60
			} );
			$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
			$( "#main span[id^='toc']" ).addClass( "toc-shim" );
			$('.dropdown-toggle').dropdown();
//			$( ".tutorial-section pre, .readme-section pre" ).addClass( "sunlight-highlight-javascript" ).addClass( "linenums" );

			$( ".tutorial-section pre, .readme-section pre" ).each( function () {
				var $this = $( this );

				var example = $this.find("code" );
				exampleText = example.html();
				var lang = /{@lang (.*?)}/.exec( exampleText );
				if ( lang && lang[1] ) {
					exampleText = exampleText.replace( lang[0], "" );
					example.html(exampleText);
					lang = lang[1];
				} else {
					lang = "javascript";
				}

				if ( lang ) {

					$this
						.addClass( "sunlight-highlight-" + lang )
						.addClass( "linenums" )
						.html( example.html() );

				}
			} );

			Sunlight.highlightAll( {
				lineNumbers : false,
				showMenu:true,
				enableDoclinks:true
		} );
		} );

	</script>

	<!--Google Analytics-->
	

	<!--Navigation and Symbol Display-->
	

</body>
</html>