http://git-wip-us.apache.org/repos/asf/polygene-website/blob/ba3a0fac/content/java/develop/javadocs/org/apache/polygene/api/property/package-tree.html ---------------------------------------------------------------------- diff --git a/content/java/develop/javadocs/org/apache/polygene/api/property/package-tree.html b/content/java/develop/javadocs/org/apache/polygene/api/property/package-tree.html new file mode 100644 index 0000000..6c4931e --- /dev/null +++ b/content/java/develop/javadocs/org/apache/polygene/api/property/package-tree.html @@ -0,0 +1,171 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="fr"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>org.apache.polygene.api.property Class Hierarchy (Apache Polygene⢠(Java Edition) SDK 3.0-SNAPSHOT)</title> +<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="org.apache.polygene.api.property Class Hierarchy (Apache Polygene\u2122 (Java Edition) SDK 3.0-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +</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</li> +<li class="navBarCell1Rev">Tree</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/polygene/api/object/package-tree.html">Prev</a></li> +<li><a href="../../../../../org/apache/polygene/api/query/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/property/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.polygene.api.property</h1> +<span class="packageHierarchyLabel">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang"><span class="typeNameLink">Object</span></a> +<ul> +<li type="circle">org.apache.polygene.api.property.<a href="../../../../../org/apache/polygene/api/property/DefaultValues.html" title="class in org.apache.polygene.api.property"><span class="typeNameLink">DefaultValues</span></a></li> +<li type="circle">org.apache.polygene.api.property.<a href="../../../../../org/apache/polygene/api/property/GenericPropertyInfo.html" title="class in org.apache.polygene.api.property"><span class="typeNameLink">GenericPropertyInfo</span></a></li> +<li type="circle">org.apache.polygene.api.property.<a href="../../../../../org/apache/polygene/api/property/Numbers.html" title="class in org.apache.polygene.api.property"><span class="typeNameLink">Numbers</span></a></li> +<li type="circle">org.apache.polygene.api.property.<a href="../../../../../org/apache/polygene/api/property/PropertyMixin.html" title="class in org.apache.polygene.api.property"><span class="typeNameLink">PropertyMixin</span></a> (implements java.lang.reflect.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/reflect/InvocationHandler.html?is-external=true" title="class or interface in java.lang.reflect">InvocationHandler</a>)</li> +<li type="circle">org.apache.polygene.api.property.<a href="../../../../../org/apache/polygene/api/property/PropertyMixin.PropertyFilter.html" title="class in org.apache.polygene.api.property"><span class="typeNameLink">PropertyMixin.PropertyFilter</span></a> (implements org.apache.polygene.api.common.<a href="../../../../../org/apache/polygene/api/common/AppliesToFilter.html" title="interface in org.apache.polygene.api.common">AppliesToFilter</a>)</li> +<li type="circle">org.apache.polygene.api.property.<a href="../../../../../org/apache/polygene/api/property/PropertyWrapper.html" title="class in org.apache.polygene.api.property"><span class="typeNameLink">PropertyWrapper</span></a> (implements org.apache.polygene.api.property.<a href="../../../../../org/apache/polygene/api/property/Property.html" title="interface in org.apache.polygene.api.property">Property</a><T>)</li> +<li type="circle">java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang"><span class="typeNameLink">Throwable</span></a> (implements java.io.<a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>) +<ul> +<li type="circle">java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang"><span class="typeNameLink">Exception</span></a> +<ul> +<li type="circle">java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang"><span class="typeNameLink">RuntimeException</span></a> +<ul> +<li type="circle">org.apache.polygene.api.common.<a href="../../../../../org/apache/polygene/api/common/ConstructionException.html" title="class in org.apache.polygene.api.common"><span class="typeNameLink">ConstructionException</span></a> +<ul> +<li type="circle">org.apache.polygene.api.property.<a href="../../../../../org/apache/polygene/api/property/InvalidPropertyTypeException.html" title="class in org.apache.polygene.api.property"><span class="typeNameLink">InvalidPropertyTypeException</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">org.apache.polygene.api.structure.<a href="../../../../../org/apache/polygene/api/structure/MetaInfoHolder.html" title="interface in org.apache.polygene.api.structure"><span class="typeNameLink">MetaInfoHolder</span></a> +<ul> +<li type="circle">org.apache.polygene.api.property.<a href="../../../../../org/apache/polygene/api/property/PropertyDescriptor.html" title="interface in org.apache.polygene.api.property"><span class="typeNameLink">PropertyDescriptor</span></a></li> +</ul> +</li> +<li type="circle">org.apache.polygene.api.property.<a href="../../../../../org/apache/polygene/api/property/Property.html" title="interface in org.apache.polygene.api.property"><span class="typeNameLink">Property</span></a><T></li> +<li type="circle">org.apache.polygene.api.property.<a href="../../../../../org/apache/polygene/api/property/StateHolder.html" title="interface in org.apache.polygene.api.property"><span class="typeNameLink">StateHolder</span></a></li> +</ul> +<h2 title="Annotation Type Hierarchy">Annotation Type Hierarchy</h2> +<ul> +<li type="circle">org.apache.polygene.api.property.<a href="../../../../../org/apache/polygene/api/property/Immutable.html" title="annotation in org.apache.polygene.api.property"><span class="typeNameLink">Immutable</span></a> (implements java.lang.annotation.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>)</li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Tree</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/polygene/api/object/package-tree.html">Prev</a></li> +<li><a href="../../../../../org/apache/polygene/api/query/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/property/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/polygene-website/blob/ba3a0fac/content/java/develop/javadocs/org/apache/polygene/api/query/MissingIndexingSystemException.html ---------------------------------------------------------------------- diff --git a/content/java/develop/javadocs/org/apache/polygene/api/query/MissingIndexingSystemException.html b/content/java/develop/javadocs/org/apache/polygene/api/query/MissingIndexingSystemException.html new file mode 100644 index 0000000..1394a6e --- /dev/null +++ b/content/java/develop/javadocs/org/apache/polygene/api/query/MissingIndexingSystemException.html @@ -0,0 +1,272 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="fr"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>MissingIndexingSystemException (Apache Polygene⢠(Java Edition) SDK 3.0-SNAPSHOT)</title> +<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="MissingIndexingSystemException (Apache Polygene\u2122 (Java Edition) SDK 3.0-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +</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="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>Prev Class</li> +<li><a href="../../../../../org/apache/polygene/api/query/NotQueryableException.html" title="class in org.apache.polygene.api.query"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/query/MissingIndexingSystemException.html" target="_top">Frames</a></li> +<li><a href="MissingIndexingSystemException.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</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.polygene.api.query</div> +<h2 title="Class MissingIndexingSystemException" class="title">Class MissingIndexingSystemException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">java.lang.RuntimeException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/polygene/api/query/QueryException.html" title="class in org.apache.polygene.api.query">org.apache.polygene.api.query.QueryException</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.polygene.api.query.MissingIndexingSystemException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">MissingIndexingSystemException</span> +extends <a href="../../../../../org/apache/polygene/api/query/QueryException.html" title="class in org.apache.polygene.api.query">QueryException</a></pre> +<div class="block">This Exception is thrown in <code>QueryBuilderFactory.newQueryBuilder()</code> method if + no indexing subsystem has been declared in the assembly.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.polygene.api.query.MissingIndexingSystemException">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/MissingIndexingSystemException.html#MissingIndexingSystemException--">MissingIndexingSystemException</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or inter face in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lan g/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="MissingIndexingSystemException--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MissingIndexingSystemException</h4> +<pre>public MissingIndexingSystemException()</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> +<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="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>Prev Class</li> +<li><a href="../../../../../org/apache/polygene/api/query/NotQueryableException.html" title="class in org.apache.polygene.api.query"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/query/MissingIndexingSystemException.html" target="_top">Frames</a></li> +<li><a href="MissingIndexingSystemException.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/polygene-website/blob/ba3a0fac/content/java/develop/javadocs/org/apache/polygene/api/query/NotQueryableException.html ---------------------------------------------------------------------- diff --git a/content/java/develop/javadocs/org/apache/polygene/api/query/NotQueryableException.html b/content/java/develop/javadocs/org/apache/polygene/api/query/NotQueryableException.html new file mode 100644 index 0000000..c5f8427 --- /dev/null +++ b/content/java/develop/javadocs/org/apache/polygene/api/query/NotQueryableException.html @@ -0,0 +1,344 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="fr"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NotQueryableException (Apache Polygene⢠(Java Edition) SDK 3.0-SNAPSHOT)</title> +<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="NotQueryableException (Apache Polygene\u2122 (Java Edition) SDK 3.0-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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="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/polygene/api/query/MissingIndexingSystemException.html" title="class in org.apache.polygene.api.query"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/query/NotQueryableException.html" target="_top">Frames</a></li> +<li><a href="NotQueryableException.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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.polygene.api.query</div> +<h2 title="Class NotQueryableException" class="title">Class NotQueryableException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">java.lang.RuntimeException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/polygene/api/query/QueryException.html" title="class in org.apache.polygene.api.query">org.apache.polygene.api.query.QueryException</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.polygene.api.query.NotQueryableException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">NotQueryableException</span> +extends <a href="../../../../../org/apache/polygene/api/query/QueryException.html" title="class in org.apache.polygene.api.query">QueryException</a></pre> +<div class="block">Thrown in case that a non queryable type or accessor (marked with @Queriable(false)) is used during query building, + or when non-Property, non-Associations are trying to be queried (possibly can not happen).</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.polygene.api.query.NotQueryableException">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/NotQueryableException.html#NotQueryableException-java.lang.String-">NotQueryableException</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</code> +<div class="block">Constructor.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/NotQueryableException.html#throwIfNotQueryable-java.lang.reflect.AccessibleObject-">throwIfNotQueryable</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true" title="class or interface in java.lang.reflect">AccessibleObject</a> accessor)</code> +<div class="block">Verify that the provided accessor method has not been marked with a Queryable(false).</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/NotQueryableException.html#throwIfNotQueryable-java.lang.Class-">throwIfNotQueryable</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type)</code> +<div class="block">Verify that the provided type has not been marked with a Queryable(false).</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or inter face in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lan g/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="NotQueryableException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>NotQueryableException</h4> +<pre>public NotQueryableException(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</pre> +<div class="block">Constructor.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>message</code> - exception message</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="throwIfNotQueryable-java.lang.reflect.AccessibleObject-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>throwIfNotQueryable</h4> +<pre>public static void throwIfNotQueryable(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true" title="class or interface in java.lang.reflect">AccessibleObject</a> accessor)</pre> +<div class="block">Verify that the provided accessor method has not been marked with a Queryable(false).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>accessor</code> - accessor method</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/polygene/api/query/NotQueryableException.html" title="class in org.apache.polygene.api.query">NotQueryableException</a></code> - - If accessor method has been marked as not queryable</dd> +</dl> +</li> +</ul> +<a name="throwIfNotQueryable-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>throwIfNotQueryable</h4> +<pre>public static void throwIfNotQueryable(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type)</pre> +<div class="block">Verify that the provided type has not been marked with a Queryable(false).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>type</code> - a type</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/polygene/api/query/NotQueryableException.html" title="class in org.apache.polygene.api.query">NotQueryableException</a></code> - - If type has been marked as not queryable</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="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/polygene/api/query/MissingIndexingSystemException.html" title="class in org.apache.polygene.api.query"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/query/NotQueryableException.html" target="_top">Frames</a></li> +<li><a href="NotQueryableException.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/polygene-website/blob/ba3a0fac/content/java/develop/javadocs/org/apache/polygene/api/query/Query.html ---------------------------------------------------------------------- diff --git a/content/java/develop/javadocs/org/apache/polygene/api/query/Query.html b/content/java/develop/javadocs/org/apache/polygene/api/query/Query.html new file mode 100644 index 0000000..5b4547e --- /dev/null +++ b/content/java/develop/javadocs/org/apache/polygene/api/query/Query.html @@ -0,0 +1,482 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="fr"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Query (Apache Polygene⢠(Java Edition) SDK 3.0-SNAPSHOT)</title> +<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="Query (Apache Polygene\u2122 (Java Edition) SDK 3.0-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":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="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/polygene/api/query/NotQueryableException.html" title="class in org.apache.polygene.api.query"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/polygene/api/query/QueryBuilder.html" title="interface in org.apache.polygene.api.query"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/query/Query.html" target="_top">Frames</a></li> +<li><a href="Query.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.polygene.api.query</div> +<h2 title="Interface Query" class="title">Interface Query<T></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Entity type</dd> +</dl> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><T>, <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">Query<T></span> +extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><T>, <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> +<div class="block">This represents a Query in an indexing system. It is created from a + <a href="../../../../../org/apache/polygene/api/query/QueryBuilder.html" title="interface in org.apache.polygene.api.query"><code>QueryBuilder</code></a>, which decides the "where" clause in the query. + <p> + Additional limitations, such as paging, ordering, and variables, can be set on + a Query before it is executed by calling one of find(), iterator(), + or count(). + </p> + <p> + DDD tip: typically Queries are created in the Domain Model and passed to the UI, + which sets the order and paging before executing it. + </p></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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/Query.html#count--">count</a></span>()</code> +<div class="block">Count how many results would be returned by this Query.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/Query.html#find--">find</a></span>()</code> +<div class="block">Get the first Entity that matches the criteria.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query">Query</a><<a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/Query.html#firstResult-int-">firstResult</a></span>(int firstResult)</code> +<div class="block">Set the index of the first result.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><V> V</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/Query.html#getVariable-java.lang.String-">getVariable</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> +<div class="block">Get the value of a named variable.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query">Query</a><<a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/Query.html#maxResults-int-">maxResults</a></span>(int maxResults)</code> +<div class="block">Set how many results should be returned.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query">Query</a><<a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/Query.html#orderBy-org.apache.polygene.api.query.grammar.OrderBy...-">orderBy</a></span>(<a href="../../../../../org/apache/polygene/api/query/grammar/OrderBy.html" title="class in org.apache.polygene.api.query.grammar">OrderBy</a>... segments)</code> +<div class="block">Set the ordering rules.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query">Query</a><<a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/Query.html#orderBy-org.apache.polygene.api.property.Property-">orderBy</a></span>(<a href="../../../../../org/apache/polygene/api/property/Property.html" title="interface in org.apache.polygene.api.property">Property</a><?> property)</code> +<div class="block">Append an ascending ordering rule to the existing segments.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query">Query</a><<a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/Query.html#orderBy-org.apache.polygene.api.property.Property-org.apache.polygene.api.query.grammar.OrderBy.Order-">orderBy</a></span>(<a href="../../../../../org/apache/polygene/api/property/Property.html" title="interface in org.apache.polygene.api.property">Property</a><?> property, + <a href="../../../../../org/apache/polygene/api/query/grammar/OrderBy.Order.html" title="enum in org.apache.polygene.api.query.grammar">OrderBy.Order</a> order)</code> +<div class="block">Append an ordering rule to the existing segments.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/Query.html#resultType--">resultType</a></span>()</code> +<div class="block">Get the result type of this Query</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query">Query</a><<a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/Query.html#setVariable-java.lang.String-java.lang.Object-">setVariable</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Set the value of a named variable.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true" title="class or interface in java.util.stream">Stream</a><<a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/Query.html#stream--">stream</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable"> +<!-- --> +</a> +<h3>Methods inherited from interface java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#iterator--" title="class or interface in java.lang">iterator</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</a></code></li> +</ul> +</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="orderBy-org.apache.polygene.api.query.grammar.OrderBy...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>orderBy</h4> +<pre><a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query">Query</a><<a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a>> orderBy(<a href="../../../../../org/apache/polygene/api/query/grammar/OrderBy.html" title="class in org.apache.polygene.api.query.grammar">OrderBy</a>... segments)</pre> +<div class="block">Set the ordering rules. If many segments are used for ordering + then they will be applied in order.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>segments</code> - the segments to order by</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the Query</dd> +</dl> +</li> +</ul> +<a name="orderBy-org.apache.polygene.api.property.Property-org.apache.polygene.api.query.grammar.OrderBy.Order-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>orderBy</h4> +<pre><a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query">Query</a><<a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a>> orderBy(<a href="../../../../../org/apache/polygene/api/property/Property.html" title="interface in org.apache.polygene.api.property">Property</a><?> property, + <a href="../../../../../org/apache/polygene/api/query/grammar/OrderBy.Order.html" title="enum in org.apache.polygene.api.query.grammar">OrderBy.Order</a> order)</pre> +<div class="block">Append an ordering rule to the existing segments.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>property</code> - the property to order by</dd> +<dd><code>order</code> - the order to apply</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the Query</dd> +</dl> +</li> +</ul> +<a name="orderBy-org.apache.polygene.api.property.Property-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>orderBy</h4> +<pre><a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query">Query</a><<a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a>> orderBy(<a href="../../../../../org/apache/polygene/api/property/Property.html" title="interface in org.apache.polygene.api.property">Property</a><?> property)</pre> +<div class="block">Append an ascending ordering rule to the existing segments.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>property</code> - the property to order by</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the Query</dd> +</dl> +</li> +</ul> +<a name="firstResult-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>firstResult</h4> +<pre><a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query">Query</a><<a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a>> firstResult(int firstResult)</pre> +<div class="block">Set the index of the first result. Default is 0 (zero).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>firstResult</code> - which index to use as the first one</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the Query</dd> +</dl> +</li> +</ul> +<a name="maxResults-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>maxResults</h4> +<pre><a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query">Query</a><<a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a>> maxResults(int maxResults)</pre> +<div class="block">Set how many results should be returned. Default is that + there is no limit set.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>maxResults</code> - that shouldbe returned</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the query</dd> +</dl> +</li> +</ul> +<a name="find--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>find</h4> +<pre><a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a> find() +throws <a href="../../../../../org/apache/polygene/api/query/QueryExecutionException.html" title="class in org.apache.polygene.api.query">QueryExecutionException</a></pre> +<div class="block">Get the first Entity that matches the criteria. This + executes the Query.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the first found Entity or null if none were found</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/polygene/api/query/QueryExecutionException.html" title="class in org.apache.polygene.api.query">QueryExecutionException</a></code> - if the query fails</dd> +</dl> +</li> +</ul> +<a name="setVariable-java.lang.String-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setVariable</h4> +<pre><a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query">Query</a><<a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a>> setVariable(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Set the value of a named variable.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - of the variable</dd> +<dd><code>value</code> - of the variable</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the query</dd> +</dl> +</li> +</ul> +<a name="getVariable-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVariable</h4> +<pre><V> V getVariable(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Get the value of a named variable.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>V</code> - Variable type</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - of the variable</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>value of the variable</dd> +</dl> +</li> +</ul> +<a name="resultType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resultType</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a>> resultType()</pre> +<div class="block">Get the result type of this Query</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the result type</dd> +</dl> +</li> +</ul> +<a name="count--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>long count() + throws <a href="../../../../../org/apache/polygene/api/query/QueryExecutionException.html" title="class in org.apache.polygene.api.query">QueryExecutionException</a></pre> +<div class="block">Count how many results would be returned by this Query. + This executes the Query.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>result count</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/polygene/api/query/QueryExecutionException.html" title="class in org.apache.polygene.api.query">QueryExecutionException</a></code> - if the query fails</dd> +</dl> +</li> +</ul> +<a name="stream--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>stream</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true" title="class or interface in java.util.stream">Stream</a><<a href="../../../../../org/apache/polygene/api/query/Query.html" title="type parameter in Query">T</a>> stream()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Stream results</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="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/polygene/api/query/NotQueryableException.html" title="class in org.apache.polygene.api.query"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/polygene/api/query/QueryBuilder.html" title="interface in org.apache.polygene.api.query"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/query/Query.html" target="_top">Frames</a></li> +<li><a href="Query.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/polygene-website/blob/ba3a0fac/content/java/develop/javadocs/org/apache/polygene/api/query/QueryBuilder.html ---------------------------------------------------------------------- diff --git a/content/java/develop/javadocs/org/apache/polygene/api/query/QueryBuilder.html b/content/java/develop/javadocs/org/apache/polygene/api/query/QueryBuilder.html new file mode 100644 index 0000000..1558bbd --- /dev/null +++ b/content/java/develop/javadocs/org/apache/polygene/api/query/QueryBuilder.html @@ -0,0 +1,264 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="fr"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>QueryBuilder (Apache Polygene⢠(Java Edition) SDK 3.0-SNAPSHOT)</title> +<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="QueryBuilder (Apache Polygene\u2122 (Java Edition) SDK 3.0-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":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="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/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/polygene/api/query/QueryBuilderFactory.html" title="interface in org.apache.polygene.api.query"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/query/QueryBuilder.html" target="_top">Frames</a></li> +<li><a href="QueryBuilder.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.polygene.api.query</div> +<h2 title="Interface QueryBuilder" class="title">Interface QueryBuilder<T></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Entity type</dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">QueryBuilder<T></span></pre> +<div class="block">QueryBuilders are used to create <a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query"><code>Query</code></a> instances. + Iteratively add where() clauses to the query, and then use + <a href="../../../../../org/apache/polygene/api/unitofwork/UnitOfWork.html#newQuery-org.apache.polygene.api.query.QueryBuilder-"><code>UnitOfWork.newQuery(QueryBuilder)</code></a> to instantiate the Query. + QueryBuilders are immutable, so when adding new where-clauses you get new instances. This + + DDD tip: Query objects are not executed immediately, so they + should be constructed in the domain model and handed over to + the UI, which can then further constrain it before actual + execution.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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><a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query">Query</a><<a href="../../../../../org/apache/polygene/api/query/QueryBuilder.html" title="type parameter in QueryBuilder">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/QueryBuilder.html#newQuery-java.lang.Iterable-">newQuery</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/polygene/api/query/QueryBuilder.html" title="type parameter in QueryBuilder">T</a>> iterable)</code> +<div class="block">Create a new query with the declared where-clauses that will be evaluated against the iterable entries.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/polygene/api/query/QueryBuilder.html" title="interface in org.apache.polygene.api.query">QueryBuilder</a><<a href="../../../../../org/apache/polygene/api/query/QueryBuilder.html" title="type parameter in QueryBuilder">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/polygene/api/query/QueryBuilder.html#where-java.util.function.Predicate-">where</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function">Predicate</a><<a href="../../../../../org/apache/polygene/api/composite/Composite.html" title="interface in org.apache.polygene.api.composite">Composite</a>> specification)</code> +<div class="block">Add a where-clause to the Query.</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="where-java.util.function.Predicate-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>where</h4> +<pre><a href="../../../../../org/apache/polygene/api/query/QueryBuilder.html" title="interface in org.apache.polygene.api.query">QueryBuilder</a><<a href="../../../../../org/apache/polygene/api/query/QueryBuilder.html" title="type parameter in QueryBuilder">T</a>> where(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function">Predicate</a><<a href="../../../../../org/apache/polygene/api/composite/Composite.html" title="interface in org.apache.polygene.api.composite">Composite</a>> specification)</pre> +<div class="block">Add a where-clause to the Query. Use <a href="../../../../../org/apache/polygene/api/query/QueryExpressions.html" title="class in org.apache.polygene.api.query"><code>QueryExpressions</code></a> + to create the expression.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>specification</code> - the where clause</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new builder with the added where-clause</dd> +</dl> +</li> +</ul> +<a name="newQuery-java.lang.Iterable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>newQuery</h4> +<pre><a href="../../../../../org/apache/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query">Query</a><<a href="../../../../../org/apache/polygene/api/query/QueryBuilder.html" title="type parameter in QueryBuilder">T</a>> newQuery(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/polygene/api/query/QueryBuilder.html" title="type parameter in QueryBuilder">T</a>> iterable)</pre> +<div class="block">Create a new query with the declared where-clauses that will be evaluated against the iterable entries.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>iterable</code> - collection of objects (composites?)</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new Query instance</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="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/polygene/api/query/Query.html" title="interface in org.apache.polygene.api.query"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/polygene/api/query/QueryBuilderFactory.html" title="interface in org.apache.polygene.api.query"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/polygene/api/query/QueryBuilder.html" target="_top">Frames</a></li> +<li><a href="QueryBuilder.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
