AfflictionNetworks/vilya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
907eaa7014cde93e994514299f845079dafc5ad4
vilya/apidocs/com/threerings/whirled/server/persist/SceneRepository.html
T
Michael Bayne 907eaa7014 Updated docs for 1.6 release.
2015-03-14 10:44:30 -07:00

315 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_31) on Sat Mar 14 10:07:12 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SceneRepository (Vilya Core 1.6 API)</title>
<meta name="date" content="2015-03-14">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SceneRepository (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SceneRepository.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/threerings/whirled/server/persist/DummySceneRepository.html" title="class in com.threerings.whirled.server.persist"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/whirled/server/persist/SceneUpdateMarshaller.html" title="class in com.threerings.whirled.server.persist"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/whirled/server/persist/SceneRepository.html" target="_top">Frames</a></li>
<li><a href="SceneRepository.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.threerings.whirled.server.persist</div>
<h2 title="Interface SceneRepository" class="title">Interface SceneRepository</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../com/threerings/whirled/server/persist/DummySceneRepository.html" title="class in com.threerings.whirled.server.persist">DummySceneRepository</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SceneRepository</span></pre>
<div class="block">The scene repository provides the basic interface for loading and updating scene data. It is
used by the scene registry and though more scene related persistence services may be needed in a
full-fledged application, the scene repository only encapsulates those needed by the scene
registry and other services provided by the Whirled framework.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/server/persist/SceneRepository.html#applyAndRecordUpdate-com.threerings.whirled.data.SceneModel-com.threerings.whirled.data.SceneUpdate-">applyAndRecordUpdate</a></span>(<a href="../../../../../com/threerings/whirled/data/SceneModel.html" title="class in com.threerings.whirled.data">SceneModel</a>&nbsp;model,
<a href="../../../../../com/threerings/whirled/data/SceneUpdate.html" title="class in com.threerings.whirled.data">SceneUpdate</a>&nbsp;update)</code>
<div class="block">Applise the supplied scene update to persistent representation of its associated scene, then
stores the update persistently for future invocations of the server to load.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/server/persist/SceneRepository.html#loadExtras-int-com.threerings.whirled.data.SceneModel-">loadExtras</a></span>(int&nbsp;sceneId,
<a href="../../../../../com/threerings/whirled/data/SceneModel.html" title="class in com.threerings.whirled.data">SceneModel</a>&nbsp;model)</code>
<div class="block">Loads optional additional scene data.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../com/threerings/whirled/data/SceneModel.html" title="class in com.threerings.whirled.data">SceneModel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/server/persist/SceneRepository.html#loadSceneModel-int-">loadSceneModel</a></span>(int&nbsp;sceneId)</code>
<div class="block">Fetches the model for the scene with the specified scene id.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/threerings/whirled/util/UpdateList.html" title="class in com.threerings.whirled.util">UpdateList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/server/persist/SceneRepository.html#loadUpdates-int-">loadUpdates</a></span>(int&nbsp;sceneId)</code>
<div class="block">Fetches the set of updates associated with the specified scene.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="loadSceneModel-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadSceneModel</h4>
<pre><a href="../../../../../com/threerings/whirled/data/SceneModel.html" title="class in com.threerings.whirled.data">SceneModel</a>&nbsp;loadSceneModel(int&nbsp;sceneId)
throws <a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/io/PersistenceException.html?is-external=true" title="class or interface in com.samskivert.io">PersistenceException</a>,
<a href="../../../../../com/threerings/whirled/util/NoSuchSceneException.html" title="class in com.threerings.whirled.util">NoSuchSceneException</a></pre>
<div class="block">Fetches the model for the scene with the specified scene id.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/io/PersistenceException.html?is-external=true" title="class or interface in com.samskivert.io">PersistenceException</a></code> - thrown if an error occurs attempting to load the scene data.</dd>
<dd><code><a href="../../../../../com/threerings/whirled/util/NoSuchSceneException.html" title="class in com.threerings.whirled.util">NoSuchSceneException</a></code> - thrown if no scene exists with the specified scene id.</dd>
</dl>
</li>
</ul>
<a name="loadUpdates-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadUpdates</h4>
<pre><a href="../../../../../com/threerings/whirled/util/UpdateList.html" title="class in com.threerings.whirled.util">UpdateList</a>&nbsp;loadUpdates(int&nbsp;sceneId)
throws <a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/io/PersistenceException.html?is-external=true" title="class or interface in com.samskivert.io">PersistenceException</a></pre>
<div class="block">Fetches the set of updates associated with the specified scene.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/io/PersistenceException.html?is-external=true" title="class or interface in com.samskivert.io">PersistenceException</a></code> - thrown if an error occurs attempting to load the scene
updates.</dd>
</dl>
</li>
</ul>
<a name="loadExtras-int-com.threerings.whirled.data.SceneModel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadExtras</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;loadExtras(int&nbsp;sceneId,
<a href="../../../../../com/threerings/whirled/data/SceneModel.html" title="class in com.threerings.whirled.data">SceneModel</a>&nbsp;model)
throws <a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/io/PersistenceException.html?is-external=true" title="class or interface in com.samskivert.io">PersistenceException</a></pre>
<div class="block">Loads optional additional scene data. This data is loaded during the scene resolution
process and made available to the scene manager via <a href="../../../../../com/threerings/whirled/server/SceneManager.html#gotSceneData-java.lang.Object-"><code>SceneManager.gotSceneData(java.lang.Object)</code></a>.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/io/PersistenceException.html?is-external=true" title="class or interface in com.samskivert.io">PersistenceException</a></code></dd>
</dl>
</li>
</ul>
<a name="applyAndRecordUpdate-com.threerings.whirled.data.SceneModel-com.threerings.whirled.data.SceneUpdate-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>applyAndRecordUpdate</h4>
<pre>void&nbsp;applyAndRecordUpdate(<a href="../../../../../com/threerings/whirled/data/SceneModel.html" title="class in com.threerings.whirled.data">SceneModel</a>&nbsp;model,
<a href="../../../../../com/threerings/whirled/data/SceneUpdate.html" title="class in com.threerings.whirled.data">SceneUpdate</a>&nbsp;update)
throws <a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/io/PersistenceException.html?is-external=true" title="class or interface in com.samskivert.io">PersistenceException</a></pre>
<div class="block">Applise the supplied scene update to persistent representation of its associated scene, then
stores the update persistently for future invocations of the server to load. <em>Note:</em>
the scene update will have already been applied to the supplied scene model.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/io/PersistenceException.html?is-external=true" title="class or interface in com.samskivert.io">PersistenceException</a></code> - thrown if an error occurs attempting to apply the scene
update.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SceneRepository.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/threerings/whirled/server/persist/DummySceneRepository.html" title="class in com.threerings.whirled.server.persist"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/whirled/server/persist/SceneUpdateMarshaller.html" title="class in com.threerings.whirled.server.persist"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/whirled/server/persist/SceneRepository.html" target="_top">Frames</a></li>
<li><a href="SceneRepository.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink