<!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_18) on Thu May 12 21:54:55 GMT 2011 -->
<TITLE>
PersistCatalog
</TITLE>
<META NAME="date" CONTENT="2011-05-12">
<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="PersistCatalog";
}
}
</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="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/sleepycat/persist/impl/ObjectArrayFormat.html" title="class in com.sleepycat.persist.impl"><B>PREV CLASS</B></A>
<A HREF="../../../../com/sleepycat/persist/impl/PersistComparator.html" title="class in com.sleepycat.persist.impl"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/sleepycat/persist/impl/PersistCatalog.html" target="_top"><B>FRAMES</B></A>
<A HREF="PersistCatalog.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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.sleepycat.persist.impl</FONT>
<BR>
Class PersistCatalog</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.persist.impl.PersistCatalog</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>PersistCatalog</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
The catalog of class formats for a store, along with its associated model
and mutations.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_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>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#BETA_VERSION">BETA_VERSION</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#CURRENT_VERSION">CURRENT_VERSION</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#expectNoClassChanges">expectNoClassChanges</A></B></CODE>
<BR>
Used by unit tests.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#unevolvedFormatsEncountered">unevolvedFormatsEncountered</A></B></CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#PersistCatalog(com.sleepycat.db.Transaction, com.sleepycat.db.Environment, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig, com.sleepycat.persist.model.EntityModel, com.sleepycat.persist.evolve.Mutations, boolean, com.sleepycat.persist.impl.Store)">PersistCatalog</A></B>(<A HREF="../../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn,
<A HREF="../../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db">Environment</A> env,
java.lang.String storePrefix,
java.lang.String dbName,
<A HREF="../../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A> dbConfig,
<A HREF="../../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</A> modelParam,
<A HREF="../../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</A> mutationsParam,
boolean rawAccess,
<A HREF="../../../../com/sleepycat/persist/impl/Store.html" title="class in com.sleepycat.persist.impl">Store</A> store)</CODE>
<BR>
Creates a new catalog, opening the database and reading it from a given
catalog database if it already exists.</TD>
</TR>
</TABLE>
<!-- ========== 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> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#close()">close</A></B>()</CODE>
<BR>
Decrements the reference count and closes the catalog DB when it reaches
zero.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#convertRawObject(com.sleepycat.persist.raw.RawObject, java.util.IdentityHashMap)">convertRawObject</A></B>(<A HREF="../../../../com/sleepycat/persist/raw/RawObject.html" title="class in com.sleepycat.persist.raw">RawObject</A> o,
java.util.IdentityHashMap converted)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#createFormat(java.lang.Class, java.util.Map)">createFormat</A></B>(java.lang.Class type,
java.util.Map<java.lang.String,<A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A>> newFormats)</CODE>
<BR>
If the given class format is not already present in the given map and
a format for this class name does not already exist, creates an
uninitialized format, adds it to the map, and also collects related
formats in the map.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#createFormat(java.lang.String, java.util.Map)">createFormat</A></B>(java.lang.String clsName,
java.util.Map<java.lang.String,<A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A>> newFormats)</CODE>
<BR>
Convenience method that gets the class for the given class name and
calls createFormat with the class object.</TD>
</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/sleepycat/persist/impl/PersistCatalog.html#flush()">flush</A></B>()</CODE>
<BR>
Used to write the catalog when a format has been changed, for example,
when Store.evolve has updated a Format's EvolveNeeded property.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.List<<A HREF="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</A>></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#getAllRawTypes()">getAllRawTypes</A></B>()</CODE>
<BR>
Returns all formats as RawTypes.</TD>
</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/sleepycat/persist/impl/PersistCatalog.html#getEntityFormats(java.util.Collection)">getEntityFormats</A></B>(java.util.Collection<<A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A>> entityFormats)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#getFormat(java.lang.Class, boolean)">getFormat</A></B>(java.lang.Class cls,
boolean checkEntitySubclassIndexes)</CODE>
<BR>
Get a format for a given class, creating it if it does not exist.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#getFormat(int)">getFormat</A></B>(int formatId)</CODE>
<BR>
Returns a format for a given ID, or throws an exception.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#getFormat(java.lang.String)">getFormat</A></B>(java.lang.String className)</CODE>
<BR>
Returns a format by class name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#getInitVersion(com.sleepycat.persist.impl.Format, boolean)">getInitVersion</A></B>(<A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> format,
boolean forReader)</CODE>
<BR>
When a format is intialized, this method is called to get the version
of the serialized object to be initialized.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#getLatestVersion(java.lang.String)">getLatestVersion</A></B>(java.lang.String className)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#getMutations()">getMutations</A></B>()</CODE>
<BR>
Returns the current merged mutations.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#getResolvedModel()">getResolvedModel</A></B>()</CODE>
<BR>
Returns the model parameter, default model or stored model.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#isRawAccess()">isRawAccess</A></B>()</CODE>
<BR>
</TD>
</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/sleepycat/persist/impl/PersistCatalog.html#openExisting()">openExisting</A></B>()</CODE>
<BR>
Increments the reference count for a catalog that is already open.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="expectNoClassChanges"><!-- --></A><H3>
expectNoClassChanges</H3>
<PRE>
public static boolean <B>expectNoClassChanges</B></PRE>
<DL>
<DD>Used by unit tests.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="unevolvedFormatsEncountered"><!-- --></A><H3>
unevolvedFormatsEncountered</H3>
<PRE>
public static boolean <B>unevolvedFormatsEncountered</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="BETA_VERSION"><!-- --></A><H3>
BETA_VERSION</H3>
<PRE>
public static final int <B>BETA_VERSION</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sleepycat.persist.impl.PersistCatalog.BETA_VERSION">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CURRENT_VERSION"><!-- --></A><H3>
CURRENT_VERSION</H3>
<PRE>
public static final int <B>CURRENT_VERSION</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sleepycat.persist.impl.PersistCatalog.CURRENT_VERSION">Constant Field Values</A></DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="PersistCatalog(com.sleepycat.db.Transaction, com.sleepycat.db.Environment, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig, com.sleepycat.persist.model.EntityModel, com.sleepycat.persist.evolve.Mutations, boolean, com.sleepycat.persist.impl.Store)"><!-- --></A><H3>
PersistCatalog</H3>
<PRE>
public <B>PersistCatalog</B>(<A HREF="../../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn,
<A HREF="../../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db">Environment</A> env,
java.lang.String storePrefix,
java.lang.String dbName,
<A HREF="../../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A> dbConfig,
<A HREF="../../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</A> modelParam,
<A HREF="../../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</A> mutationsParam,
boolean rawAccess,
<A HREF="../../../../com/sleepycat/persist/impl/Store.html" title="class in com.sleepycat.persist.impl">Store</A> store)
throws <A HREF="../../../../com/sleepycat/persist/StoreExistsException.html" title="class in com.sleepycat.persist">StoreExistsException</A>,
<A HREF="../../../../com/sleepycat/persist/StoreNotFoundException.html" title="class in com.sleepycat.persist">StoreNotFoundException</A>,
<A HREF="../../../../com/sleepycat/persist/evolve/IncompatibleClassException.html" title="class in com.sleepycat.persist.evolve">IncompatibleClassException</A>,
<A HREF="../../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Creates a new catalog, opening the database and reading it from a given
catalog database if it already exists. All predefined formats and
formats for the given model are added. For modified classes, old
formats are defined based on the rules for compatible class changes and
the given mutations. If any format is changed or added, and the
database is not read-only, write the initialized catalog to the
database.
<P>
<DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sleepycat/persist/StoreExistsException.html" title="class in com.sleepycat.persist">StoreExistsException</A></CODE>
<DD><CODE><A HREF="../../../../com/sleepycat/persist/StoreNotFoundException.html" title="class in com.sleepycat.persist">StoreNotFoundException</A></CODE>
<DD><CODE><A HREF="../../../../com/sleepycat/persist/evolve/IncompatibleClassException.html" title="class in com.sleepycat.persist.evolve">IncompatibleClassException</A></CODE>
<DD><CODE><A HREF="../../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DL>
<!-- ============ 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="getEntityFormats(java.util.Collection)"><!-- --></A><H3>
getEntityFormats</H3>
<PRE>
public void <B>getEntityFormats</B>(java.util.Collection<<A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A>> entityFormats)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getResolvedModel()"><!-- --></A><H3>
getResolvedModel</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</A> <B>getResolvedModel</B>()</PRE>
<DL>
<DD>Returns the model parameter, default model or stored model.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="openExisting()"><!-- --></A><H3>
openExisting</H3>
<PRE>
public void <B>openExisting</B>()</PRE>
<DL>
<DD>Increments the reference count for a catalog that is already open.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
public boolean <B>close</B>()
throws <A HREF="../../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Decrements the reference count and closes the catalog DB when it reaches
zero. Returns true if the database was closed or false if the reference
count is still non-zero and the database was left open.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getMutations()"><!-- --></A><H3>
getMutations</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</A> <B>getMutations</B>()</PRE>
<DL>
<DD>Returns the current merged mutations.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="createFormat(java.lang.String, java.util.Map)"><!-- --></A><H3>
createFormat</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> <B>createFormat</B>(java.lang.String clsName,
java.util.Map<java.lang.String,<A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A>> newFormats)</PRE>
<DL>
<DD>Convenience method that gets the class for the given class name and
calls createFormat with the class object.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#createFormat(java.lang.String, java.util.Map)"><CODE>createFormat(java.lang.String, java.util.Map<java.lang.String, com.sleepycat.persist.impl.Format>)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="createFormat(java.lang.Class, java.util.Map)"><!-- --></A><H3>
createFormat</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> <B>createFormat</B>(java.lang.Class type,
java.util.Map<java.lang.String,<A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A>> newFormats)</PRE>
<DL>
<DD>If the given class format is not already present in the given map and
a format for this class name does not already exist, creates an
uninitialized format, adds it to the map, and also collects related
formats in the map.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#createFormat(java.lang.String, java.util.Map)"><CODE>createFormat(java.lang.String, java.util.Map<java.lang.String, com.sleepycat.persist.impl.Format>)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getAllRawTypes()"><!-- --></A><H3>
getAllRawTypes</H3>
<PRE>
public java.util.List<<A HREF="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</A>> <B>getAllRawTypes</B>()</PRE>
<DL>
<DD>Returns all formats as RawTypes.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getInitVersion(com.sleepycat.persist.impl.Format, boolean)"><!-- --></A><H3>
getInitVersion</H3>
<PRE>
public int <B>getInitVersion</B>(<A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> format,
boolean forReader)</PRE>
<DL>
<DD>When a format is intialized, this method is called to get the version
of the serialized object to be initialized. See Catalog.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getFormat(int)"><!-- --></A><H3>
getFormat</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> <B>getFormat</B>(int formatId)</PRE>
<DL>
<DD>Returns a format for a given ID, or throws an exception. This method is
used when reading an object from the byte array format.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getFormat(java.lang.Class, boolean)"><!-- --></A><H3>
getFormat</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> <B>getFormat</B>(java.lang.Class cls,
boolean checkEntitySubclassIndexes)</PRE>
<DL>
<DD>Get a format for a given class, creating it if it does not exist.
<p>This method is called for top level entity instances by
PersistEntityBinding. When a new entity subclass format is added we
call Store.checkEntitySubclassSecondaries to ensure that all secondary
databases have been opened, before storing the entity. We do this here
while not holding a synchronization mutex, not in addNewFormat, to avoid
deadlocks. checkEntitySubclassSecondaries synchronizes on the Store.
[#16399]</p>
<p>Historical note: At one time we opened / created the secondary
databases rather than requiring the user to open them, see [#15247].
Later we found this to be problematic since a user txn may have locked
primary records, see [#16399].</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DD><CODE>checkEntitySubclassIndexes</CODE> - is true if we're expecting this format
to be an entity subclass and therefore subclass secondary indexes should
be opened.</DL>
</DD>
</DL>
<HR>
<A NAME="getFormat(java.lang.String)"><!-- --></A><H3>
getFormat</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> <B>getFormat</B>(java.lang.String className)</PRE>
<DL>
<DD>Returns a format by class name. Unlike <CODE>#getFormat(Class)</CODE>, the
format will not be created if it is not already known.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getLatestVersion(java.lang.String)"><!-- --></A><H3>
getLatestVersion</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</A> <B>getLatestVersion</B>(java.lang.String className)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="flush()"><!-- --></A><H3>
flush</H3>
<PRE>
public void <B>flush</B>()
throws <A HREF="../../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Used to write the catalog when a format has been changed, for example,
when Store.evolve has updated a Format's EvolveNeeded property. Uses
auto-commit.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="isRawAccess()"><!-- --></A><H3>
isRawAccess</H3>
<PRE>
public boolean <B>isRawAccess</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#isRawAccess()"><CODE>isRawAccess()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="convertRawObject(com.sleepycat.persist.raw.RawObject, java.util.IdentityHashMap)"><!-- --></A><H3>
convertRawObject</H3>
<PRE>
public java.lang.Object <B>convertRawObject</B>(<A HREF="../../../../com/sleepycat/persist/raw/RawObject.html" title="class in com.sleepycat.persist.raw">RawObject</A> o,
java.util.IdentityHashMap converted)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../com/sleepycat/persist/impl/PersistCatalog.html#convertRawObject(com.sleepycat.persist.raw.RawObject, java.util.IdentityHashMap)"><CODE>convertRawObject(com.sleepycat.persist.raw.RawObject, java.util.IdentityHashMap)</CODE></A></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="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/sleepycat/persist/impl/ObjectArrayFormat.html" title="class in com.sleepycat.persist.impl"><B>PREV CLASS</B></A>
<A HREF="../../../../com/sleepycat/persist/impl/PersistComparator.html" title="class in com.sleepycat.persist.impl"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/sleepycat/persist/impl/PersistCatalog.html" target="_top"><B>FRAMES</B></A>
<A HREF="PersistCatalog.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
