Google Git
Sign in
apache / cayenne-website / 0af753b3ec346c0432aa26fe6065228badfd46ed / . / docs / 3.1 / api / org / apache / cayenne / merge / MergerToken.html
blob: 7c29d45e0526180c24769606bd8d7c191f7ed786 [file] [log] [blame]
<!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 (version 1.7.0_67) on Sat Sep 20 17:22:55 FET 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>MergerToken (Cayenne Documentation 3.1 API)</title>
<meta name="date" content="2014-09-20">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MergerToken (Cayenne Documentation 3.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/MergerToken.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="../../../../org/apache/cayenne/merge/MergerFactory.html" title="class in org.apache.cayenne.merge"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/merge/ModelMergeDelegate.html" title="interface in org.apache.cayenne.merge"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/merge/MergerToken.html" target="_top">Frames</a></li>
<li><a href="MergerToken.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All 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">org.apache.cayenne.merge</div>
<h2 title="Interface MergerToken" class="title">Interface MergerToken</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/cayenne/merge/AbstractToDbToken.html" title="class in org.apache.cayenne.merge">AbstractToDbToken</a>, <a href="../../../../org/apache/cayenne/merge/AbstractToModelToken.html" title="class in org.apache.cayenne.merge">AbstractToModelToken</a>, <a href="../../../../org/apache/cayenne/merge/AddColumnToDb.html" title="class in org.apache.cayenne.merge">AddColumnToDb</a>, <a href="../../../../org/apache/cayenne/merge/AddColumnToModel.html" title="class in org.apache.cayenne.merge">AddColumnToModel</a>, <a href="../../../../org/apache/cayenne/merge/AddRelationshipToDb.html" title="class in org.apache.cayenne.merge">AddRelationshipToDb</a>, <a href="../../../../org/apache/cayenne/merge/AddRelationshipToModel.html" title="class in org.apache.cayenne.merge">AddRelationshipToModel</a>, <a href="../../../../org/apache/cayenne/merge/CreateTableToDb.html" title="class in org.apache.cayenne.merge">CreateTableToDb</a>, <a href="../../../../org/apache/cayenne/merge/CreateTableToModel.html" title="class in org.apache.cayenne.merge">CreateTableToModel</a>, <a href="../../../../org/apache/cayenne/merge/DropColumnToDb.html" title="class in org.apache.cayenne.merge">DropColumnToDb</a>, <a href="../../../../org/apache/cayenne/merge/DropColumnToModel.html" title="class in org.apache.cayenne.merge">DropColumnToModel</a>, <a href="../../../../org/apache/cayenne/merge/DropRelationshipToDb.html" title="class in org.apache.cayenne.merge">DropRelationshipToDb</a>, <a href="../../../../org/apache/cayenne/merge/DropRelationshipToModel.html" title="class in org.apache.cayenne.merge">DropRelationshipToModel</a>, <a href="../../../../org/apache/cayenne/merge/DropTableToDb.html" title="class in org.apache.cayenne.merge">DropTableToDb</a>, <a href="../../../../org/apache/cayenne/merge/DropTableToModel.html" title="class in org.apache.cayenne.merge">DropTableToModel</a>, <a href="../../../../org/apache/cayenne/merge/SetAllowNullToDb.html" title="class in org.apache.cayenne.merge">SetAllowNullToDb</a>, <a href="../../../../org/apache/cayenne/merge/SetAllowNullToModel.html" title="class in org.apache.cayenne.merge">SetAllowNullToModel</a>, <a href="../../../../org/apache/cayenne/merge/SetColumnTypeToDb.html" title="class in org.apache.cayenne.merge">SetColumnTypeToDb</a>, <a href="../../../../org/apache/cayenne/merge/SetColumnTypeToModel.html" title="class in org.apache.cayenne.merge">SetColumnTypeToModel</a>, <a href="../../../../org/apache/cayenne/merge/SetNotNullToDb.html" title="class in org.apache.cayenne.merge">SetNotNullToDb</a>, <a href="../../../../org/apache/cayenne/merge/SetNotNullToModel.html" title="class in org.apache.cayenne.merge">SetNotNullToModel</a>, <a href="../../../../org/apache/cayenne/merge/SetPrimaryKeyToDb.html" title="class in org.apache.cayenne.merge">SetPrimaryKeyToDb</a>, <a href="../../../../org/apache/cayenne/merge/SetPrimaryKeyToModel.html" title="class in org.apache.cayenne.merge">SetPrimaryKeyToModel</a>, <a href="../../../../org/apache/cayenne/merge/SetValueForNullToDb.html" title="class in org.apache.cayenne.merge">SetValueForNullToDb</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">MergerToken</span></pre>
</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/merge/MergerToken.html" title="interface in org.apache.cayenne.merge">MergerToken</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/merge/MergerToken.html#createReverse(org.apache.cayenne.merge.MergerFactory)">createReverse</a></strong>(<a href="../../../../org/apache/cayenne/merge/MergerFactory.html" title="class in org.apache.cayenne.merge">MergerFactory</a>&nbsp;factory)</code>
<div class="block">Create a token with the reverse direction.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/merge/MergerToken.html#execute(org.apache.cayenne.merge.MergerContext)">execute</a></strong>(<a href="../../../../org/apache/cayenne/merge/MergerContext.html" title="interface in org.apache.cayenne.merge">MergerContext</a>&nbsp;mergerContext)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/merge/MergeDirection.html" title="enum in org.apache.cayenne.merge">MergeDirection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/merge/MergerToken.html#getDirection()">getDirection</a></strong>()</code>
<div class="block">The direction of this token.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/merge/MergerToken.html#getTokenName()">getTokenName</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/merge/MergerToken.html#getTokenValue()">getTokenValue</a></strong>()</code>&nbsp;</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="getTokenName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTokenName</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getTokenName()</pre>
</li>
</ul>
<a name="getTokenValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTokenValue</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getTokenValue()</pre>
</li>
</ul>
<a name="getDirection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDirection</h4>
<pre><a href="../../../../org/apache/cayenne/merge/MergeDirection.html" title="enum in org.apache.cayenne.merge">MergeDirection</a>&nbsp;getDirection()</pre>
<div class="block">The direction of this token. One of <a href="../../../../org/apache/cayenne/merge/MergeDirection.html#TO_DB"><code>MergeDirection.TO_DB</code></a> or
<a href="../../../../org/apache/cayenne/merge/MergeDirection.html#TO_MODEL"><code>MergeDirection.TO_MODEL</code></a></div>
</li>
</ul>
<a name="createReverse(org.apache.cayenne.merge.MergerFactory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createReverse</h4>
<pre><a href="../../../../org/apache/cayenne/merge/MergerToken.html" title="interface in org.apache.cayenne.merge">MergerToken</a>&nbsp;createReverse(<a href="../../../../org/apache/cayenne/merge/MergerFactory.html" title="class in org.apache.cayenne.merge">MergerFactory</a>&nbsp;factory)</pre>
<div class="block">Create a token with the reverse direction. AddColumn in one direction becomes
DropColumn in the other direction.
<p>
Not all tokens are reversible.</div>
</li>
</ul>
<a name="execute(org.apache.cayenne.merge.MergerContext)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>execute</h4>
<pre>void&nbsp;execute(<a href="../../../../org/apache/cayenne/merge/MergerContext.html" title="interface in org.apache.cayenne.merge">MergerContext</a>&nbsp;mergerContext)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/MergerToken.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="../../../../org/apache/cayenne/merge/MergerFactory.html" title="class in org.apache.cayenne.merge"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/merge/ModelMergeDelegate.html" title="interface in org.apache.cayenne.merge"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/merge/MergerToken.html" target="_top">Frames</a></li>
<li><a href="MergerToken.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All 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; 2001&#x2013;2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>