Michael Bayne
307 lines
16 KiB
HTML
307 lines
16 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<!-- Generated by javadoc (build 1.6.0_24) on Wed Apr 06 17:00:16 PDT 2011 -->
|
|
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<TITLE>
|
|
SceneRepository (vilya 1.3 API)
|
|
</TITLE>
|
|
|
|
<META NAME="date" CONTENT="2011-04-06">
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
|
|
|
<SCRIPT type="text/javascript">
|
|
function windowTitle()
|
|
{
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="SceneRepository (vilya 1.3 API)";
|
|
}
|
|
}
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
</NOSCRIPT>
|
|
|
|
</HEAD>
|
|
|
|
<BODY BGCOLOR="white" onload="windowTitle();">
|
|
<HR>
|
|
|
|
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<A NAME="navbar_top"><!-- --></A>
|
|
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SceneRepository.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../../com/threerings/whirled/server/persist/DummySceneRepository.html" title="class in com.threerings.whirled.server.persist"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../../../com/threerings/whirled/server/persist/SceneUpdateMarshaller.html" title="class in com.threerings.whirled.server.persist"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../../index.html?com/threerings/whirled/server/persist/SceneRepository.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="SceneRepository.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
com.threerings.whirled.server.persist</FONT>
|
|
<BR>
|
|
Interface SceneRepository</H2>
|
|
<DL>
|
|
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../com/threerings/whirled/server/persist/DummySceneRepository.html" title="class in com.threerings.whirled.server.persist">DummySceneRepository</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public interface <B>SceneRepository</B></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
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.
|
|
<P>
|
|
|
|
<P>
|
|
<HR>
|
|
|
|
<P>
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/server/persist/SceneRepository.html#applyAndRecordUpdate(com.threerings.whirled.data.SceneModel, com.threerings.whirled.data.SceneUpdate)">applyAndRecordUpdate</A></B>(<A HREF="../../../../../com/threerings/whirled/data/SceneModel.html" title="class in com.threerings.whirled.data">SceneModel</A> model,
|
|
<A HREF="../../../../../com/threerings/whirled/data/SceneUpdate.html" title="class in com.threerings.whirled.data">SceneUpdate</A> update)</CODE>
|
|
|
|
<BR>
|
|
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.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/server/persist/SceneRepository.html#loadExtras(int, com.threerings.whirled.data.SceneModel)">loadExtras</A></B>(int sceneId,
|
|
<A HREF="../../../../../com/threerings/whirled/data/SceneModel.html" title="class in com.threerings.whirled.data">SceneModel</A> model)</CODE>
|
|
|
|
<BR>
|
|
Loads optional additional scene data.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../../com/threerings/whirled/data/SceneModel.html" title="class in com.threerings.whirled.data">SceneModel</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/server/persist/SceneRepository.html#loadSceneModel(int)">loadSceneModel</A></B>(int sceneId)</CODE>
|
|
|
|
<BR>
|
|
Fetches the model for the scene with the specified scene id.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../../com/threerings/whirled/util/UpdateList.html" title="class in com.threerings.whirled.util">UpdateList</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/server/persist/SceneRepository.html#loadUpdates(int)">loadUpdates</A></B>(int sceneId)</CODE>
|
|
|
|
<BR>
|
|
Fetches the set of updates associated with the specified scene.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="loadSceneModel(int)"><!-- --></A><H3>
|
|
loadSceneModel</H3>
|
|
<PRE>
|
|
<A HREF="../../../../../com/threerings/whirled/data/SceneModel.html" title="class in com.threerings.whirled.data">SceneModel</A> <B>loadSceneModel</B>(int sceneId)
|
|
throws <A HREF="http://samskivert.googlecode.com/svn/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>
|
|
<DL>
|
|
<DD>Fetches the model for the scene with the specified scene id.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="http://samskivert.googlecode.com/svn/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><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.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="loadUpdates(int)"><!-- --></A><H3>
|
|
loadUpdates</H3>
|
|
<PRE>
|
|
<A HREF="../../../../../com/threerings/whirled/util/UpdateList.html" title="class in com.threerings.whirled.util">UpdateList</A> <B>loadUpdates</B>(int sceneId)
|
|
throws <A HREF="http://samskivert.googlecode.com/svn/apidocs/com/samskivert/io/PersistenceException.html?is-external=true" title="class or interface in com.samskivert.io">PersistenceException</A></PRE>
|
|
<DL>
|
|
<DD>Fetches the set of updates associated with the specified scene.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="http://samskivert.googlecode.com/svn/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.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="loadExtras(int, com.threerings.whirled.data.SceneModel)"><!-- --></A><H3>
|
|
loadExtras</H3>
|
|
<PRE>
|
|
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>loadExtras</B>(int sceneId,
|
|
<A HREF="../../../../../com/threerings/whirled/data/SceneModel.html" title="class in com.threerings.whirled.data">SceneModel</A> model)
|
|
throws <A HREF="http://samskivert.googlecode.com/svn/apidocs/com/samskivert/io/PersistenceException.html?is-external=true" title="class or interface in com.samskivert.io">PersistenceException</A></PRE>
|
|
<DL>
|
|
<DD>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>.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="http://samskivert.googlecode.com/svn/apidocs/com/samskivert/io/PersistenceException.html?is-external=true" title="class or interface in com.samskivert.io">PersistenceException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="applyAndRecordUpdate(com.threerings.whirled.data.SceneModel, com.threerings.whirled.data.SceneUpdate)"><!-- --></A><H3>
|
|
applyAndRecordUpdate</H3>
|
|
<PRE>
|
|
void <B>applyAndRecordUpdate</B>(<A HREF="../../../../../com/threerings/whirled/data/SceneModel.html" title="class in com.threerings.whirled.data">SceneModel</A> model,
|
|
<A HREF="../../../../../com/threerings/whirled/data/SceneUpdate.html" title="class in com.threerings.whirled.data">SceneUpdate</A> update)
|
|
throws <A HREF="http://samskivert.googlecode.com/svn/apidocs/com/samskivert/io/PersistenceException.html?is-external=true" title="class or interface in com.samskivert.io">PersistenceException</A></PRE>
|
|
<DL>
|
|
<DD>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.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="http://samskivert.googlecode.com/svn/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.</DL>
|
|
</DD>
|
|
</DL>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<HR>
|
|
|
|
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SceneRepository.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../../com/threerings/whirled/server/persist/DummySceneRepository.html" title="class in com.threerings.whirled.server.persist"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../../../com/threerings/whirled/server/persist/SceneUpdateMarshaller.html" title="class in com.threerings.whirled.server.persist"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../../index.html?com/threerings/whirled/server/persist/SceneRepository.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="SceneRepository.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
Copyright © 2011. All Rights Reserved.
|
|
</BODY>
|
|
</HTML>
|