You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by re...@apache.org on 2022/07/07 09:57:07 UTC
svn commit: r1902519 [16/27] - in /jackrabbit/site/live/jcr: ./ components/ css/ fonts/ js/ ocm/ status/
Modified: jackrabbit/site/live/jcr/node-type-notation.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/jcr/node-type-notation.html?rev=1902519&r1=1902518&r2=1902519&view=diff
==============================================================================
--- jackrabbit/site/live/jcr/node-type-notation.html (original)
+++ jackrabbit/site/live/jcr/node-type-notation.html Thu Jul 7 09:57:06 2022
@@ -1,40 +1,42 @@
<!DOCTYPE html>
-
-
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/markdown/node-type-notation.md at 2022-07-05
- | Rendered using Apache Maven Fluido Skin 1.11.1
+ | Generated by Apache Maven Doxia Site Renderer 1.9.2 from src\site\markdown/node-type-notation.md at 2022-05-09
+ | Rendered using Apache Maven Fluido Skin 1.9
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
- <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" />
+ <meta name="generator" content="Apache Maven Doxia Site Renderer 1.9.2" />
<title>Apache Jackrabbit – Node Type Notation</title>
- <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.1.min.css" />
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.9.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
- <script src="./js/apache-maven-fluido-1.11.1.min.js"></script>
-
- <!-- Matomo -->
- <script>
- var _paq = window._paq = window._paq || [];
- _paq.push(['disableCookies']);
- _paq.push(['trackPageView']);
- _paq.push(['enableLinkTracking']);
-
- (function() {
- var u="https://analytics.apache.org";
- _paq.push(['setTrackerUrl', u+'/matomo.php']);
- _paq.push(['setSiteId', '4']);
- var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
- g.async=true; g.src=u+'/matomo.js'; s.parentNode.insertBefore(g,s);
- })();
- </script>
- <!-- End Matomo Code -->
+ <script src="./js/apache-maven-fluido-1.9.min.js"></script>
+<!-- Matomo -->
+<script>
+ var _paq = window._paq = window._paq || [];
+ /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
+ /* We explicitly disable cookie tracking to avoid privacy issues */
+ _paq.push(['disableCookies']);
+ _paq.push(['trackPageView']);
+ _paq.push(['enableLinkTracking']);
+ (function() {
+ var u="https://matomo.privacy.apache.org/";
+ _paq.push(['setTrackerUrl', u+'matomo.php']);
+ _paq.push(['setSiteId', '4']);
+ var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+ g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
+ })();
+</script>
+<!-- End Matomo Code -->
</head>
<body class="topBarEnabled">
- <a class="github-fork-ribbon right-top" href="https://github.com/apache/jackrabbit" data-ribbon="Fork me on GitHub" title="Fork me on GitHub">Fork me on GitHub</a>
+ <a href="https://github.com/apache/jackrabbit">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+ alt="Fork me on GitHub">
+ </a>
<header id="topbar" class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<div class="container-fluid">
@@ -47,7 +49,7 @@
</a>
<ul class="nav">
<li class="dropdown">
- <a class="dropdown-toggle" data-toggle="dropdown">Apache Jackrabbit <b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Jackrabbit <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="index.html" title="Welcome">Welcome</a></li>
<li><a href="downloads.html" title="Downloads">Downloads</a></li>
@@ -58,7 +60,7 @@
</ul>
</li>
<li class="dropdown">
- <a class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="getting-started-with-apache-jackrabbit.html" title="Getting Started">Getting Started</a></li>
<li><a href="standalone-server.html" title="Standalone Server">Standalone Server</a></li>
@@ -73,7 +75,7 @@
</ul>
</li>
<li class="dropdown">
- <a class="dropdown-toggle" data-toggle="dropdown">Development <b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Development <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="jackrabbit-team.html" title="Jackrabbit Team">Jackrabbit Team</a></li>
<li><a href="jackrabbit-roadmap.html" title="Jackrabbit Roadmap">Jackrabbit Roadmap</a></li>
@@ -88,7 +90,7 @@
</ul>
</li>
<li class="dropdown">
- <a class="dropdown-toggle" data-toggle="dropdown">Apache Software Foundation <b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Software Foundation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="https://www.apache.org/foundation/how-it-works.html" title="Introduction">Introduction</a></li>
<li><a href="https://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
@@ -103,7 +105,7 @@
<div class="container-fluid">
<header>
<div id="banner">
- <div class="pull-left"><div id="bannerLeft"><h1>Apache Jackrabbit Site</h1>
+ <div class="pull-left"><div id="bannerLeft"><h2>Apache Jackrabbit Site</h2>
</div>
</div>
<div class="pull-right"></div>
@@ -112,7 +114,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2022-07-05</li>
+ <li id="publishDate">Last Published: 2022-05-09</li>
</ul>
</div>
</header>
@@ -157,6 +159,7 @@
</ul>
</nav>
<div class="well sidebar-nav">
+ <hr />
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
@@ -183,14 +186,11 @@
limitations under the License.
-->
<h1>Node Type Notation</h1>
-<p>The Compact Namespace and Node Type Definition (CND) notation provides a
-compact standardized syntax for defining node types and making namespace
-declarations. The notation is intended both for documentation and for
-programmatically registering node types (if you are unfamiliar with JCR
-node types, you may want to read the general Node Types section first).</p>
+<p>The Compact Namespace and Node Type Definition (CND) notation provides a compact standardized syntax for defining node types and making namespace declarations. The notation is intended both for documentation and for programmatically registering node types (if you are unfamiliar with JCR node types, you may want to read the general Node Types section first).</p>
<p>Here is a “worst-case scenario” example that demonstrates all the features of the notation:</p>
-<div class="source"><pre class="prettyprint linenums"><code>/* An example node type definition */
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">/* An example node type definition */
// The namespace declaration
<ns = 'http://namespace.com/ns'>
@@ -244,10 +244,12 @@ multiple
// and has an on-parent-version setting of ...
version
-</code></pre></div>
+</pre></div></div>
+
<p>This definition can be written more compactly and with indentation:</p>
-<div class="source"><pre class="prettyprint linenums"><code>/* An example node type definition */
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">/* An example node type definition */
<ns = 'http://namespace.com/ns'>
[ns:NodeType] > ns:ParentType1, ns:ParentType2
orderable mixin
@@ -259,18 +261,22 @@ version
+ ns:node (ns:reqType1, ns:reqType2)
= ns:defaultType
mandatory autocreated protected multiple version
-</code></pre></div>
+</pre></div></div>
+
<p>or, using short forms for the attributes, even like this:</p>
-<div class="source"><pre class="prettyprint linenums"><code><ns='http://namespace.com/ns'>
+<div class="source">
+<div class="source"><pre class="prettyprint linenums"><ns='http://namespace.com/ns'>
[ns:NodeType] >ns:ParentType1, ns:ParentType2 o m
- ex:property='default1','default2' ! m a p * version <'constraint1', 'constraint2'
+ ns:node(ns:reqType1,ns:reqType2)=ns:defaultType m a p * version
-</code></pre></div><section>
+</pre></div></div>
+<section>
<h2><a name="Grammar"></a>Grammar</h2>
<p>The following grammar defines the CND notation. Terminal symbols are in double quotes.</p>
-<div class="source"><pre class="prettyprint linenums"><code>cnd ::= {ns_mapping | node_type_def}
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">cnd ::= {ns_mapping | node_type_def}
ns_mapping ::= "<" prefix "=" uri ">"
prefix ::= string
uri ::= string
@@ -316,80 +322,74 @@ string_list ::= string {"," st
string ::= quoted_string | unquoted_string
quoted_string :: = "'" unquoted_string "'"
unquoted_string ::= [A-Za-z0-9:_]+
-</code></pre></div></section><section>
+</pre></div></div>
+</section><section>
<h2><a name="CND_Notation_in_Detail"></a>CND Notation in Detail</h2>
-<div class="source"><pre class="prettyprint linenums"><code>cnd ::= {ns_mapping | node_type_def}
-</code></pre></div>
-<p>A CND consists of zero or more blocks, each of which is either namespace
-declaration or a node type definition. Namespace prefixes referenced in a
-node type definition block must be declared in a preceding namespace
-declaration block.</p><section>
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">cnd ::= {ns_mapping | node_type_def}
+</pre></div></div>
+
+<p>A CND consists of zero or more blocks, each of which is either namespace declaration or a node type definition. Namespace prefixes referenced in a node type definition block must be declared in a preceding namespace declaration block.</p><section>
<h3><a name="Namespace_Declaration"></a>Namespace Declaration</h3>
-<div class="source"><pre class="prettyprint linenums"><code>ns_mapping ::= "<" prefix "=" uri ">"
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">ns_mapping ::= "<" prefix "=" uri ">"
prefix ::= string
uri ::= string
-</code></pre></div>
-<p>A namespace declaration consists of prefix/URI pair. The prefix must be a
-valid JCR namespace prefix, which is the same as a valid XML namespace
-prefix. The URI can in fact be any string. Just as in XML, it need not
-actually be a URI, though adhering to that convention is recommended.</p></section><section>
+</pre></div></div>
+
+<p>A namespace declaration consists of prefix/URI pair. The prefix must be a valid JCR namespace prefix, which is the same as a valid XML namespace prefix. The URI can in fact be any string. Just as in XML, it need not actually be a URI, though adhering to that convention is recommended.</p></section><section>
<h3><a name="Node_Type_Definition"></a>Node Type Definition</h3>
-<div class="source"><pre class="prettyprint linenums"><code>node_type_def ::= node_type_name [super_types] [options] {property_def | child_node_def}
-</code></pre></div>
-<p>A node type definition consists of a node type name followed by an optional
-supertypes block, an optional options block and zero or more blocks, each
-either a property or node definition.</p></section><section>
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">node_type_def ::= node_type_name [super_types] [options] {property_def | child_node_def}
+</pre></div></div>
+
+<p>A node type definition consists of a node type name followed by an optional supertypes block, an optional options block and zero or more blocks, each either a property or node definition.</p></section><section>
<h3><a name="Node_Type_Name"></a>Node Type Name</h3>
-<div class="source"><pre class="prettyprint linenums"><code>node_type_name ::= "[" string "]"
-</code></pre></div>
-<p>The node type name is delimited by square brackets and must be a valid JCR
-name. It may be single-quoted (see Quoting, below). This element is the
-only strictly required element within a node type definition, though a
-definition consisting only of a node type name would simply define a new
-node type identical to nt:base.</p></section><section>
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">node_type_name ::= "[" string "]"
+</pre></div></div>
+
+<p>The node type name is delimited by square brackets and must be a valid JCR name. It may be single-quoted (see Quoting, below). This element is the only strictly required element within a node type definition, though a definition consisting only of a node type name would simply define a new node type identical to nt:base.</p></section><section>
<h3><a name="Supertypes"></a>Supertypes</h3>
-<div class="source"><pre class="prettyprint linenums"><code>supertypes ::= ">" string_list
-</code></pre></div>
-<p>After the node type name comes the optional list of supertypes. If this
-element is not present and the node type is not a mixin (see ?1.3.5
-Options), then a supertype of nt:base is assumed. If present, the element
-consists of a greater-than sign followed by a comma delimited list of node
-type names, each of which may optionally be single-quoted (see Quoting
-below). In Jackrabbit, multiple inheritance of node types is supported, so
-this list can be greater than one item in length.</p></section><section>
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">supertypes ::= ">" string_list
+</pre></div></div>
+
+<p>After the node type name comes the optional list of supertypes. If this element is not present and the node type is not a mixin (see ?1.3.5 Options), then a supertype of nt:base is assumed. If present, the element consists of a greater-than sign followed by a comma delimited list of node type names, each of which may optionally be single-quoted (see Quoting below). In Jackrabbit, multiple inheritance of node types is supported, so this list can be greater than one item in length.</p></section><section>
<h3><a name="Options"></a>Options</h3>
-<div class="source"><pre class="prettyprint linenums"><code>options ::= orderable_opt | mixin_opt | orderable_opt mixin_opt | mixin_opt orderable_opt
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">options ::= orderable_opt | mixin_opt | orderable_opt mixin_opt | mixin_opt orderable_opt
orderable_opt ::= "orderable" | "ord" | "o"
mixin_opt ::= "mixin" | "mix" | "m"
-</code></pre></div>
+</pre></div></div>
+
<p>The option indicators follow the node type name and optional supertype list.</p>
-<p>If the keyword orderable (or a short form) is present, then the orderable
-child node setting of the node type is true. If the keyword is missing,
-then the setting is false.</p>
-<p>If the keyword mixin (or a short form) is present, then this is a mixin
-node type. If the keyword is missing, then this is a primary node type.</p></section><section>
+<p>If the keyword orderable (or a short form) is present, then the orderable child node setting of the node type is true. If the keyword is missing, then the setting is false.</p>
+<p>If the keyword mixin (or a short form) is present, then this is a mixin node type. If the keyword is missing, then this is a primary node type.</p></section><section>
<h3><a name="Property_Definition"></a>Property Definition</h3>
-<div class="source"><pre class="prettyprint linenums"><code>property_def ::= "-" property_name [property_type_decl] [default_values] [attributes] [value_constraints]
-</code></pre></div>
-<p>A property definition consists of a minus sign followed by a property name,
-followed in turn by optional elements defining the property type, the
-default values, the property attributes and the value constraints.</p></section><section>
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">property_def ::= "-" property_name [property_type_decl] [default_values] [attributes] [value_constraints]
+</pre></div></div>
+
+<p>A property definition consists of a minus sign followed by a property name, followed in turn by optional elements defining the property type, the default values, the property attributes and the value constraints.</p></section><section>
<h3><a name="Property_Name"></a>Property Name</h3>
-<div class="source"><pre class="prettyprint linenums"><code>property_name ::= string
-</code></pre></div>
-<p>The property name must be a valid JCR name or *, to indicate a residual
-property definition. It may be single-quoted.</p></section><section>
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">property_name ::= string
+</pre></div></div>
+
+<p>The property name must be a valid JCR name or *, to indicate a residual property definition. It may be single-quoted.</p></section><section>
<h3><a name="Property_Type"></a>Property Type</h3>
-<div class="source"><pre class="prettyprint linenums"><code>property_type_decl ::= "(" property_type ")"
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">property_type_decl ::= "(" property_type ")"
property_type ::= "STRING" | "String |"string" |
"BINARY" | "Binary" | "binary" |
"LONG" | "Long" | "long" |
@@ -400,20 +400,20 @@ property_type ::= "STRING" | &
"PATH" | "Path" | "path" |
"REFERENCE" | "Reference" | "reference" |
"UNDEFINED" | "Undefined" | "undefined" | "*"
-</code></pre></div>
-<p>The property type is indicated by a keyword delimited by parentheses. If
-the property type declaration is missing a type of STRING is assumed.</p></section><section>
+</pre></div></div>
+
+<p>The property type is indicated by a keyword delimited by parentheses. If the property type declaration is missing a type of STRING is assumed.</p></section><section>
<h3><a name="Default_Values"></a>Default Values</h3>
-<div class="source"><pre class="prettyprint linenums"><code>default_values ::= "=" string_list
-</code></pre></div>
-<p>The default value or values, in the case of a multi-value property, are
-indicated by an equal sign followed by either a single value in string form
-or a comma-delimited list of values. The values may be single-quoted. If
-the default value definition is missing then no default value is set.</p></section><section>
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">default_values ::= "=" string_list
+</pre></div></div>
+
+<p>The default value or values, in the case of a multi-value property, are indicated by an equal sign followed by either a single value in string form or a comma-delimited list of values. The values may be single-quoted. If the default value definition is missing then no default value is set.</p></section><section>
<h3><a name="Attributes"></a>Attributes</h3>
-<div class="source"><pre class="prettyprint linenums"><code>attributes ::= "primary" | "pri" | "!" |
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">attributes ::= "primary" | "pri" | "!" |
"autocreated" | "aut" | "a" |
"mandatory" | "man" | "m" |
"protected" | "pro" | "p" |
@@ -424,54 +424,51 @@ the default value definition is missing
"COMPUTE" | "Compute" | "compute" |
"IGNORE" | "Ignore" | "ignore" |
"ABORT" | "Abort" | "abort"
-</code></pre></div>
-<p>The attribute indicators describe the characteristics of the property. The
-presence of an attribute keyword indicates that the corresponding
-characteristic applies to this property. It's absence indicates that the
-corresponding characteristic does not apply.</p>
-<p>The primary keyword indicates that this property is the primary item. It
-may appear on a maximum of one property or child node definition within a
-node type definition.</p>
+</pre></div></div>
+
+<p>The attribute indicators describe the characteristics of the property. The presence of an attribute keyword indicates that the corresponding characteristic applies to this property. It’s absence indicates that the corresponding characteristic does not apply.</p>
+<p>The primary keyword indicates that this property is the primary item. It may appear on a maximum of one property or child node definition within a node type definition.</p>
<p>The multiple keyword indicates that this property is multi-valued.</p>
-<p>A maximum of one on-version indicator may be present. If none is present
-then an on-version setting of COPY is assumed.</p></section><section>
+<p>A maximum of one on-version indicator may be present. If none is present then an on-version setting of COPY is assumed.</p></section><section>
<h3><a name="Value_Constraints"></a>Value Constraints</h3>
-<div class="source"><pre class="prettyprint linenums"><code>value_constraints ::= "<" string_list
-</code></pre></div>
-<p>Value constraint are specified by a less-than sign followed by a
-comma-delimited list of constraint strings, each optionally single-quoted.</p></section><section>
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">value_constraints ::= "<" string_list
+</pre></div></div>
+
+<p>Value constraint are specified by a less-than sign followed by a comma-delimited list of constraint strings, each optionally single-quoted.</p></section><section>
<h3><a name="Child_Node_Definition"></a>Child Node Definition</h3>
-<div class="source"><pre class="prettyprint linenums"><code>child_node_def ::= "+" node_name [required_types] [default_type] [attributes]
-</code></pre></div>
-<p>A child node definition consists of a plus sign followed by a property
-name, followed in turn by optional elements defining the required primary
-node types, the default node type, and the node attributes.</p></section><section>
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">child_node_def ::= "+" node_name [required_types] [default_type] [attributes]
+</pre></div></div>
+
+<p>A child node definition consists of a plus sign followed by a property name, followed in turn by optional elements defining the required primary node types, the default node type, and the node attributes.</p></section><section>
<h3><a name="Node_Name"></a>Node Name</h3>
-<div class="source"><pre class="prettyprint linenums"><code>node_name ::= string
-</code></pre></div>
-<p>The node name must be a valid JCR name or <code>*</code>, to indicate a residual child
-node definition. It may be single-quoted.</p></section><section>
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">node_name ::= string
+</pre></div></div>
+
+<p>The node name must be a valid JCR name or <code>*</code>, to indicate a residual child node definition. It may be single-quoted.</p></section><section>
<h3><a name="Required_Primary_Node_Types"></a>Required Primary Node Types</h3>
-<div class="source"><pre class="prettyprint linenums"><code>required_types ::= "(" string_list ")"
-</code></pre></div>
-<p>The required node types of the child node are indicated by a
-comma-delimited list of node types, within parentheses. If this element is
-missing then a required primary node type of nt:base is assumed. This is
-the least restrictive setting possible.</p></section><section>
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">required_types ::= "(" string_list ")"
+</pre></div></div>
+
+<p>The required node types of the child node are indicated by a comma-delimited list of node types, within parentheses. If this element is missing then a required primary node type of nt:base is assumed. This is the least restrictive setting possible.</p></section><section>
<h3><a name="Default_Primary_Node_Type"></a>Default Primary Node Type</h3>
-<div class="source"><pre class="prettyprint linenums"><code>default_type ::= "=" string
-</code></pre></div>
-<p>The default primary node type is indicated by an equals-sign followed by a
-node type name, which may be single-quoted. If this element is missing then
-no default primary node type is set.</p></section><section>
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">default_type ::= "=" string
+</pre></div></div>
+
+<p>The default primary node type is indicated by an equals-sign followed by a node type name, which may be single-quoted. If this element is missing then no default primary node type is set.</p></section><section>
<h3><a name="Attributes"></a>Attributes</h3>
-<div class="source"><pre class="prettyprint linenums"><code>attributes ::= "primary" | "pri" | "!" |
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">attributes ::= "primary" | "pri" | "!" |
"autocreated" | "aut" | "a" |
"mandatory" | "man" | "m" |
"protected" | "pro" | "p" |
@@ -482,32 +479,27 @@ no default primary node type is set.</p>
"COMPUTE" | "Compute" | "compute" |
"IGNORE" | "Ignore" | "ignore" |
"ABORT" | "Abort" | "abort"
-</code></pre></div>
-<p>The attribute indicators describe the characteristics of the child node.
-The presence of an attribute keyword indicates that the corresponding
-characteristic applies to this child node. It's absence indicates that the
-corresponding characteristic does not apply.</p>
-<p>The primary keyword indicates that this child node is the primary item. It
-may appear on a maximum of one property or child node definition within a
-node type definition.</p>
-<p>The multiple keyword indicates that this child node may have same-name
-siblings.</p>
-<p>A maximum of one on-version indicator may be present. If none is present
-then an on-version setting of COPY is assumed.</p></section><section>
+</pre></div></div>
+
+<p>The attribute indicators describe the characteristics of the child node. The presence of an attribute keyword indicates that the corresponding characteristic applies to this child node. It’s absence indicates that the corresponding characteristic does not apply.</p>
+<p>The primary keyword indicates that this child node is the primary item. It may appear on a maximum of one property or child node definition within a node type definition.</p>
+<p>The multiple keyword indicates that this child node may have same-name siblings.</p>
+<p>A maximum of one on-version indicator may be present. If none is present then an on-version setting of COPY is assumed.</p></section><section>
<h3><a name="Quoting"></a>Quoting</h3>
-<div class="source"><pre class="prettyprint linenums"><code>string_list ::= string {"," string}
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">string_list ::= string {"," string}
string ::= quoted_string | unquoted_string
quoted_string :: = "'" unquoted_string "'"
unquoted_string ::= /* a string */
-</code></pre></div>
-<p>Single quotes (') are used to allow for strings (i.e., names, prefixes,
-URIs, values or constraint strings) with characters that would otherwise be
-interpreted as delimiters.</p></section><section>
+</pre></div></div>
+
+<p>Single quotes (') are used to allow for strings (i.e., names, prefixes, URIs, values or constraint strings) with characters that would otherwise be interpreted as delimiters.</p></section><section>
<h3><a name="Escaping"></a>Escaping</h3>
<p>The standard Java escape sequences are also supported:</p>
-<div class="source"><pre class="prettyprint linenums"><code>\n newline
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">\n newline
\t tab
\b backspace
\f form feed
@@ -516,35 +508,37 @@ interpreted as delimiters.</p></section>
\' single quote
\\ back slash
\uHHHH Unicode character in hexadecimal
-</code></pre></div></section><section>
+</pre></div></div>
+</section><section>
<h3><a name="Comments"></a>Comments</h3>
-<p>Comment can also be included in the notation using either of the standard
-Java forms:</p>
+<p>Comment can also be included in the notation using either of the standard Java forms:</p>
-<div class="source"><pre class="prettyprint linenums"><code>// A comment
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">// A comment
/* Another comment */
-</code></pre></div></section><section>
+</pre></div></div>
+</section><section>
<h3><a name="Whitespace_and_Short_Forms"></a>Whitespace and Short Forms</h3>
-<p>The notation can be compacted by taking advantage of the following the fact that spacing around keychars
-(<code>[ ] > , - ( ) = <</code>), newlines and indentation are not required. So, the
-following is also well-formed:</p>
-
-<div class="source"><pre class="prettyprint linenums"><code>[x] >y,z orderable mixin -p(date)=a,b primary mandatory autocreated protected multiple version <c,d
-</code></pre></div>
-<p>Additionally, though spaces are required around the keywords (orderable,
-mixin, date, mandatory, etc.), short forms for keywords can be used. So,
-this:</p>
+<p>The notation can be compacted by taking advantage of the following the fact that spacing around keychars (<code>[ ] > , - ( ) = <</code>), newlines and indentation are not required. So, the following is also well-formed:</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">[x] >y,z orderable mixin -p(date)=a,b primary mandatory autocreated protected multiple version <c,d
+</pre></div></div>
+
+<p>Additionally, though spaces are required around the keywords (orderable, mixin, date, mandatory, etc.), short forms for keywords can be used. So, this:</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">[x] >y,z o m-p(date)=a,b ! m a p * version <c,d
+</pre></div></div>
-<div class="source"><pre class="prettyprint linenums"><code>[x] >y,z o m-p(date)=a,b ! m a p * version <c,d
-</code></pre></div>
<p>is well-formed (but perhaps not recommended!).</p></section><section>
<h3><a name="Why_this_Weird_Notation.3F"></a>Why this Weird Notation?</h3>
-<p>Here's why:</p>
+<p>Here’s why:</p>
<p>Old Documentation Notation</p>
-<p>Here is the definition of the built-in node type nt:resource using the old
-documentation notation (used in v1.0 of the JCR specification, for example):</p>
+<p>Here is the definition of the built-in node type nt:resource using the old documentation notation (used in v1.0 of the JCR specification, for example):</p>
-<div class="source"><pre class="prettyprint linenums"><code>NodeTypeName
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">NodeTypeName
nt:resource
Supertypes
nt:base
@@ -595,12 +589,13 @@ PropertyDefinition
OnParentVersion IGNORE
Protected false
Multiple false
-</code></pre></div>
+</pre></div></div>
+
<p>Old Configuration Notation</p>
-<p>Here is the same node type in the standard XML notation (used in
-configuration files in the Jackrabbit project, for example):</p>
+<p>Here is the same node type in the standard XML notation (used in configuration files in the Jackrabbit project, for example):</p>
-<div class="source"><pre class="prettyprint linenums"><code><nodeType name="nt:resource"
+<div class="source">
+<div class="source"><pre class="prettyprint linenums"><nodeType name="nt:resource"
isMixin="false"
hasOrderableChildNodes="false"
primaryItemName="jcr:data">
@@ -637,16 +632,19 @@ configuration files in the Jackrabbit pr
protected="false"
multiple="false"/>
</nodeType>
-</code></pre></div>
+</pre></div></div>
+
<p>New Format</p>
<p>And, here it is in the new CND notation:</p>
-<div class="source"><pre class="prettyprint linenums"><code>[nt:resource] > mix:referenceable
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">[nt:resource] > mix:referenceable
- jcr:encoding
- jcr:mimeType mandatory
- jcr:data (binary) mandatory
- jcr:lastModified (date) mandatory ignore
-</code></pre></div>
+</pre></div></div>
+
<p>Case closed.</p></section></section><section>
<h2><a name="Syntax_highlighting_for_text_editors"></a>Syntax highlighting for text editors</h2>
<p>Here is a TextMate bundle for CND syntax highlighting: <a href="CND.zip">CND.zip</a></p></section>
@@ -661,12 +659,10 @@ configuration files in the Jackrabbit pr
<a href="https://www.apache.org/">The Apache Software Foundation</a> | <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a>
</p>
</div>
- </div>
+ <div id="ohloh" class="pull-right">
+ <script src="https://www.ohloh.net/p/jackrabbit/widgets/project_users_logo.js"></script>
+ </div>
+ </div>
</footer>
-<script>
- if(anchors) {
- anchors.add();
- }
-</script>
</body>
</html>
\ No newline at end of file
Modified: jackrabbit/site/live/jcr/node-type-visualization.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/jcr/node-type-visualization.html?rev=1902519&r1=1902518&r2=1902519&view=diff
==============================================================================
--- jackrabbit/site/live/jcr/node-type-visualization.html (original)
+++ jackrabbit/site/live/jcr/node-type-visualization.html Thu Jul 7 09:57:06 2022
@@ -1,40 +1,42 @@
<!DOCTYPE html>
-
-
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/markdown/node-type-visualization.md at 2022-07-05
- | Rendered using Apache Maven Fluido Skin 1.11.1
+ | Generated by Apache Maven Doxia Site Renderer 1.9.2 from src\site\markdown/node-type-visualization.md at 2022-05-09
+ | Rendered using Apache Maven Fluido Skin 1.9
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
- <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" />
+ <meta name="generator" content="Apache Maven Doxia Site Renderer 1.9.2" />
<title>Apache Jackrabbit – Node Type Visualization</title>
- <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.1.min.css" />
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.9.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
- <script src="./js/apache-maven-fluido-1.11.1.min.js"></script>
-
- <!-- Matomo -->
- <script>
- var _paq = window._paq = window._paq || [];
- _paq.push(['disableCookies']);
- _paq.push(['trackPageView']);
- _paq.push(['enableLinkTracking']);
-
- (function() {
- var u="https://analytics.apache.org";
- _paq.push(['setTrackerUrl', u+'/matomo.php']);
- _paq.push(['setSiteId', '4']);
- var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
- g.async=true; g.src=u+'/matomo.js'; s.parentNode.insertBefore(g,s);
- })();
- </script>
- <!-- End Matomo Code -->
+ <script src="./js/apache-maven-fluido-1.9.min.js"></script>
+<!-- Matomo -->
+<script>
+ var _paq = window._paq = window._paq || [];
+ /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
+ /* We explicitly disable cookie tracking to avoid privacy issues */
+ _paq.push(['disableCookies']);
+ _paq.push(['trackPageView']);
+ _paq.push(['enableLinkTracking']);
+ (function() {
+ var u="https://matomo.privacy.apache.org/";
+ _paq.push(['setTrackerUrl', u+'matomo.php']);
+ _paq.push(['setSiteId', '4']);
+ var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+ g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
+ })();
+</script>
+<!-- End Matomo Code -->
</head>
<body class="topBarEnabled">
- <a class="github-fork-ribbon right-top" href="https://github.com/apache/jackrabbit" data-ribbon="Fork me on GitHub" title="Fork me on GitHub">Fork me on GitHub</a>
+ <a href="https://github.com/apache/jackrabbit">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+ alt="Fork me on GitHub">
+ </a>
<header id="topbar" class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<div class="container-fluid">
@@ -47,7 +49,7 @@
</a>
<ul class="nav">
<li class="dropdown">
- <a class="dropdown-toggle" data-toggle="dropdown">Apache Jackrabbit <b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Jackrabbit <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="index.html" title="Welcome">Welcome</a></li>
<li><a href="downloads.html" title="Downloads">Downloads</a></li>
@@ -58,7 +60,7 @@
</ul>
</li>
<li class="dropdown">
- <a class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="getting-started-with-apache-jackrabbit.html" title="Getting Started">Getting Started</a></li>
<li><a href="standalone-server.html" title="Standalone Server">Standalone Server</a></li>
@@ -73,7 +75,7 @@
</ul>
</li>
<li class="dropdown">
- <a class="dropdown-toggle" data-toggle="dropdown">Development <b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Development <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="jackrabbit-team.html" title="Jackrabbit Team">Jackrabbit Team</a></li>
<li><a href="jackrabbit-roadmap.html" title="Jackrabbit Roadmap">Jackrabbit Roadmap</a></li>
@@ -88,7 +90,7 @@
</ul>
</li>
<li class="dropdown">
- <a class="dropdown-toggle" data-toggle="dropdown">Apache Software Foundation <b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Software Foundation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="https://www.apache.org/foundation/how-it-works.html" title="Introduction">Introduction</a></li>
<li><a href="https://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
@@ -103,7 +105,7 @@
<div class="container-fluid">
<header>
<div id="banner">
- <div class="pull-left"><div id="bannerLeft"><h1>Apache Jackrabbit Site</h1>
+ <div class="pull-left"><div id="bannerLeft"><h2>Apache Jackrabbit Site</h2>
</div>
</div>
<div class="pull-right"></div>
@@ -112,7 +114,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2022-07-05</li>
+ <li id="publishDate">Last Published: 2022-05-09</li>
</ul>
</div>
</header>
@@ -157,6 +159,7 @@
</ul>
</nav>
<div class="well sidebar-nav">
+ <hr />
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
@@ -183,28 +186,16 @@
limitations under the License.
-->
<h1>Node Type Visualization</h1>
-<p>Visualizing the Node Type Hierarchy is non-trivial, even in the case of a
-repository containing only the default Jackrabbit node types. Here,
-GraphViz can help:</p>
+<p>Visualizing the Node Type Hierarchy is non-trivial, even in the case of a repository containing only the default Jackrabbit node types. Here, GraphViz can help:</p>
<p><img src="jackrabbit-nodetypes.png" alt="Jackrabbit Nodetypes" /></p>
<p>Node Type Hierarchy for Jackrabbit (<a href="jackrabbit-nodetypes.svg">SVG version</a>)</p>
-<p>In this diagram, the rounded boxes represent node types (green for mixins,
-gold for primrary types), with the arrows indicating the node inheritance.
-The square boxes represent child node and property definitions.</p>
+<p>In this diagram, the rounded boxes represent node types (green for mixins, gold for primrary types), with the arrows indicating the node inheritance. The square boxes represent child node and property definitions.</p>
<p>To generate these diagrams, you will need:</p>
<ol style="list-style-type: decimal">
-<li>
-
-<p>A system view export of <code>/jcr:system/jcr:nodeTypes</code>.</p>
-</li>
-<li>
-
-<p>An XSLT processor and the XSLT code below.</p>
-</li>
-<li>
-
-<p>The <a class="externalLink" href="http://graphviz.org/">GraphViz</a> tool</p> <!--
+<li>A system view export of <code>/jcr:system/jcr:nodeTypes</code>.</li>
+<li>An XSLT processor and the XSLT code below.</li>
+<li>The <a class="externalLink" href="http://graphviz.org/">GraphViz</a> tool<!--
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
@@ -220,7 +211,7 @@ The square boxes represent child node an
* See the License for the specific language governing permissions and
* limitations under the License.
-->
- <!--
+<!--
A tool for converting the system view of /jcr:system/jcr:nodeTypes
to GraphViz input (see <http://www.graphviz.org/>).
@@ -239,84 +230,56 @@ The square boxes represent child node an
...producing nt-sample.svg as output.
-->
-<p><xsl:transform xmlns:xsl=“<a class="externalLink" href="http://www.w3.org/1999/XSL/Transform">http://www.w3.org/1999/XSL/Transform</a>”
-version=“1.0”
-xmlns:ed=“<a class="externalLink" href="http://greenbytes.de/2002/rfcedit">http://greenbytes.de/2002/rfcedit</a>”
-xmlns:exslt=“<a class="externalLink" href="http://exslt.org/common">http://exslt.org/common</a>”
-xmlns:nt=“<a class="externalLink" href="http://www.jcp.org/jcr/nt/1.0">http://www.jcp.org/jcr/nt/1.0</a>”
-xmlns:sv=“<a class="externalLink" href="http://www.jcp.org/jcr/sv/1.0">http://www.jcp.org/jcr/sv/1.0</a>”
-xmlns:jcr=“<a class="externalLink" href="http://www.jcp.org/jcr/1.0">http://www.jcp.org/jcr/1.0</a>”</p>
+<p><xsl:transform xmlns:xsl=“<a class="externalLink" href="http://www.w3.org/1999/XSL/Transform">http://www.w3.org/1999/XSL/Transform</a>” version=“1.0” xmlns:ed=“<a class="externalLink" href="http://greenbytes.de/2002/rfcedit">http://greenbytes.de/2002/rfcedit</a>” xmlns:exslt=“<a class="externalLink" href="http://exslt.org/common">http://exslt.org/common</a>” xmlns:nt=“<a class="externalLink" href="http://www.jcp.org/jcr/nt/1.0">http://www.jcp.org/jcr/nt/1.0</a>” xmlns:sv=“<a class="externalLink" href="http://www.jcp.org/jcr/sv/1.0">http://www.jcp.org/jcr/sv/1.0</a>” xmlns:jcr=“<a class="externalLink" href="http://www.jcp.org/jcr/1.0">http://www.jcp.org/jcr/1.0</a>”</p>
<blockquote></blockquote>
<p><xsl:output method=“text” encoding=“UTF-8”/></p>
-<p><xsl:template match=“/”>
-<a href="xsl:text">xsl:text</a>digraph {
-</xsl:text>
-<a href="xsl:text">xsl:text</a> rankdir=LR;
-</xsl:text>
-<xsl:apply-templates select=“//sv:node[sv:property[@sv:name=‘jcr:primaryType’]/sv:value=‘nt:nodeType’]”/>
-<a href="xsl:text">xsl:text</a>}
-</xsl:text>
-</xsl:template></p>
-<p><xsl:template match=“sv:node[sv:property[@sv:name=‘jcr:primaryType’]/sv:value=‘nt:nodeType’]”>
-<a href="xsl:text">xsl:text</a> “</xsl:text>
-<xsl:value-of select=”@sv:name"/>
-<a href="xsl:text">xsl:text</a>" </xsl:text>
-<a href="xsl:choose">xsl:choose</a>
-<xsl:when test=“sv:property[@sv:name=‘jcr:isMixin’] /sv:value=‘true’”>
-<a href="xsl:text">xsl:text</a>[style = “filled, rounded”, fillcolor = greenyellow];</xsl:text>
-</xsl:when>
-<a href="xsl:otherwise">xsl:otherwise</a>
-<a href="xsl:text">xsl:text</a>[style = “filled, rounded”, fillcolor = gold] ;</xsl:text>
-</xsl:otherwise>
-</xsl:choose>
-<a href="xsl:text">xsl:text</a>
+<p><xsl:template match=“/”> <a href="xsl:text">xsl:text</a>digraph {
+</xsl:text> <a href="xsl:text">xsl:text</a> rankdir=LR;
+</xsl:text> <xsl:apply-templates select=“//sv:node[sv:property[@sv:name=‘jcr:primaryType’]/sv:value=‘nt:nodeType’]”/> <a href="xsl:text">xsl:text</a>}
+</xsl:text> </xsl:template></p>
+<p><xsl:template match=“sv:node[sv:property[@sv:name=‘jcr:primaryType’]/sv:value=‘nt:nodeType’]”> <a href="xsl:text">xsl:text</a> “</xsl:text> <xsl:value-of select=”@sv:name"/> <a href="xsl:text">xsl:text</a>" </xsl:text> <a href="xsl:choose">xsl:choose</a> <xsl:when test=“sv:property[@sv:name=‘jcr:isMixin’] /sv:value=‘true’”> <a href="xsl:text">xsl:text</a>[style = “filled, rounded”, fillcolor = greenyellow];</xsl:text> </xsl:when> <a href="xsl:otherwise">xsl:otherwise</a> <a href="xsl:text">xsl:text</a>[style = “filled, rounded”, fillcolor = gold] ;</xsl:text> </xsl:otherwise> </xsl:choose> <a href="xsl:text">xsl:text</a>
</xsl:text></p>
-<p><xsl:for-each select=“sv:property[@sv:name=‘jcr:supertypes’]/sv:value”>
-<a href="xsl:text">xsl:text</a> “</xsl:text>
-<xsl:value-of select=”.“/>
-<a href="xsl:text">xsl:text</a>” -> “</xsl:text>
-<xsl:value-of select=”../../@sv:name"/>
-<a href="xsl:text">xsl:text</a>" [dir = back, tooltip = “supertype”] ;
-</xsl:text>
-</xsl:for-each></p>
+<p><xsl:for-each select=“sv:property[@sv:name=‘jcr:supertypes’]/sv:value”> <a href="xsl:text">xsl:text</a> “</xsl:text> <xsl:value-of select=”.“/> <a href="xsl:text">xsl:text</a>” -> “</xsl:text> <xsl:value-of select=”../../@sv:name"/> <a href="xsl:text">xsl:text</a>" [dir = back, tooltip = “supertype”] ;
+</xsl:text> </xsl:for-each></p>
<p><xsl:for-each select=“sv:node[@sv:name=‘jcr:childNodeDefinition’]”></p>
-<div class="source"><pre class="prettyprint linenums"><code> <xsl:variable name="name">
- <xsl:choose>
- <xsl:when test="sv:property[@sv:name='jcr:name']">
- <xsl:value-of select="sv:property[@sv:name='jcr:name']/sv:value"/>
- </xsl:when>
- <xsl:otherwise>*</xsl:otherwise>
- </xsl:choose>
- </xsl:variable>
-
- <xsl:variable name="id" select="generate-id()"/>
-
- <xsl:value-of select="concat(' &quot;',$id,'&quot; [shape = box, style = filled, fillcolor = khaki, label=&quot;',$name,'&quot;]&#10;')"/>
-
- <xsl:text> "</xsl:text>
- <xsl:value-of select="../@sv:name"/>
- <xsl:text>" -> "</xsl:text>
- <xsl:value-of select="$id"/>
- <xsl:choose>
- <xsl:when test="sv:property[@sv:name='jcr:mandatory']/sv:value='true'">
- <xsl:text>" [tooltip = "is mandatory child node of", dir = back];&#10;</xsl:text>
- </xsl:when>
- <xsl:otherwise>
- <xsl:text>" [style = dotted, tooltip = "is child node of", dir = back];&#10;</xsl:text>
- </xsl:otherwise>
- </xsl:choose>
-
- <xsl:text> "</xsl:text>
- <xsl:value-of select="sv:property[@sv:name='jcr:requiredPrimaryTypes']/sv:value"/>
- <xsl:text>" -> "</xsl:text>
- <xsl:value-of select="$id"/>
- <xsl:text>" [dir = back, tooltip = "has primary type"];&#10;</xsl:text>
-</code></pre></div>
+<div class="source">
+<div class="source"><pre class="prettyprint linenums"><xsl:variable name="name">
+ <xsl:choose>
+ <xsl:when test="sv:property[@sv:name='jcr:name']">
+ <xsl:value-of select="sv:property[@sv:name='jcr:name']/sv:value"/>
+</xsl:when>
+<xsl:otherwise>*</xsl:otherwise>
+ </xsl:choose>
+</xsl:variable>
+
+<xsl:variable name="id" select="generate-id()"/>
+
+<xsl:value-of select="concat(' &quot;',$id,'&quot; [shape = box, style = filled, fillcolor = khaki, label=&quot;',$name,'&quot;]&#10;')"/>
+
+<xsl:text> "</xsl:text>
+<xsl:value-of select="../@sv:name"/>
+<xsl:text>" -> "</xsl:text>
+<xsl:value-of select="$id"/>
+<xsl:choose>
+ <xsl:when test="sv:property[@sv:name='jcr:mandatory']/sv:value='true'">
+<xsl:text>" [tooltip = "is mandatory child node of", dir = back];&#10;</xsl:text>
+ </xsl:when>
+ <xsl:otherwise>
+<xsl:text>" [style = dotted, tooltip = "is child node of", dir = back];&#10;</xsl:text>
+ </xsl:otherwise>
+</xsl:choose>
+
+<xsl:text> "</xsl:text>
+<xsl:value-of select="sv:property[@sv:name='jcr:requiredPrimaryTypes']/sv:value"/>
+<xsl:text>" -> "</xsl:text>
+<xsl:value-of select="$id"/>
+<xsl:text>" [dir = back, tooltip = "has primary type"];&#10;</xsl:text>
+</pre></div></div>
+
<p></xsl:for-each></p>
<p></xsl:template></p>
-<p></xsl:transform></p>
-</li>
+<p></xsl:transform></p></li>
</ol>
</main>
</div>
@@ -329,12 +292,10 @@ xmlns:jcr=“<a class="externalLink
<a href="https://www.apache.org/">The Apache Software Foundation</a> | <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a>
</p>
</div>
- </div>
+ <div id="ohloh" class="pull-right">
+ <script src="https://www.ohloh.net/p/jackrabbit/widgets/project_users_logo.js"></script>
+ </div>
+ </div>
</footer>
-<script>
- if(anchors) {
- anchors.add();
- }
-</script>
</body>
</html>
\ No newline at end of file
Modified: jackrabbit/site/live/jcr/node-types.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/jcr/node-types.html?rev=1902519&r1=1902518&r2=1902519&view=diff
==============================================================================
--- jackrabbit/site/live/jcr/node-types.html (original)
+++ jackrabbit/site/live/jcr/node-types.html Thu Jul 7 09:57:06 2022
@@ -1,40 +1,42 @@
<!DOCTYPE html>
-
-
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/markdown/node-types.md at 2022-07-05
- | Rendered using Apache Maven Fluido Skin 1.11.1
+ | Generated by Apache Maven Doxia Site Renderer 1.9.2 from src\site\markdown/node-types.md at 2022-05-09
+ | Rendered using Apache Maven Fluido Skin 1.9
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
- <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" />
+ <meta name="generator" content="Apache Maven Doxia Site Renderer 1.9.2" />
<title>Apache Jackrabbit – Node Types</title>
- <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.1.min.css" />
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.9.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
- <script src="./js/apache-maven-fluido-1.11.1.min.js"></script>
-
- <!-- Matomo -->
- <script>
- var _paq = window._paq = window._paq || [];
- _paq.push(['disableCookies']);
- _paq.push(['trackPageView']);
- _paq.push(['enableLinkTracking']);
-
- (function() {
- var u="https://analytics.apache.org";
- _paq.push(['setTrackerUrl', u+'/matomo.php']);
- _paq.push(['setSiteId', '4']);
- var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
- g.async=true; g.src=u+'/matomo.js'; s.parentNode.insertBefore(g,s);
- })();
- </script>
- <!-- End Matomo Code -->
+ <script src="./js/apache-maven-fluido-1.9.min.js"></script>
+<!-- Matomo -->
+<script>
+ var _paq = window._paq = window._paq || [];
+ /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
+ /* We explicitly disable cookie tracking to avoid privacy issues */
+ _paq.push(['disableCookies']);
+ _paq.push(['trackPageView']);
+ _paq.push(['enableLinkTracking']);
+ (function() {
+ var u="https://matomo.privacy.apache.org/";
+ _paq.push(['setTrackerUrl', u+'matomo.php']);
+ _paq.push(['setSiteId', '4']);
+ var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+ g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
+ })();
+</script>
+<!-- End Matomo Code -->
</head>
<body class="topBarEnabled">
- <a class="github-fork-ribbon right-top" href="https://github.com/apache/jackrabbit" data-ribbon="Fork me on GitHub" title="Fork me on GitHub">Fork me on GitHub</a>
+ <a href="https://github.com/apache/jackrabbit">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+ alt="Fork me on GitHub">
+ </a>
<header id="topbar" class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<div class="container-fluid">
@@ -47,7 +49,7 @@
</a>
<ul class="nav">
<li class="dropdown">
- <a class="dropdown-toggle" data-toggle="dropdown">Apache Jackrabbit <b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Jackrabbit <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="index.html" title="Welcome">Welcome</a></li>
<li><a href="downloads.html" title="Downloads">Downloads</a></li>
@@ -58,7 +60,7 @@
</ul>
</li>
<li class="dropdown">
- <a class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="getting-started-with-apache-jackrabbit.html" title="Getting Started">Getting Started</a></li>
<li><a href="standalone-server.html" title="Standalone Server">Standalone Server</a></li>
@@ -68,12 +70,12 @@
<li><a href="jackrabbit-architecture.html" title="Jackrabbit Architecture">Jackrabbit Architecture</a></li>
<li><a href="deployment-models.html" title="Deployment Models">Deployment Models</a></li>
<li><a href="jackrabbit-configuration.html" title="Jackrabbit Configuration">Jackrabbit Configuration</a></li>
- <li><a title="Node Types">Node Types</a></li>
+ <li><a href="node-types.html" title="Node Types">Node Types</a></li>
<li><a href="object-content-mapping.html" title="Object Content Mapping">Object Content Mapping</a></li>
</ul>
</li>
<li class="dropdown">
- <a class="dropdown-toggle" data-toggle="dropdown">Development <b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Development <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="jackrabbit-team.html" title="Jackrabbit Team">Jackrabbit Team</a></li>
<li><a href="jackrabbit-roadmap.html" title="Jackrabbit Roadmap">Jackrabbit Roadmap</a></li>
@@ -88,7 +90,7 @@
</ul>
</li>
<li class="dropdown">
- <a class="dropdown-toggle" data-toggle="dropdown">Apache Software Foundation <b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Software Foundation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="https://www.apache.org/foundation/how-it-works.html" title="Introduction">Introduction</a></li>
<li><a href="https://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
@@ -103,7 +105,7 @@
<div class="container-fluid">
<header>
<div id="banner">
- <div class="pull-left"><div id="bannerLeft"><h1>Apache Jackrabbit Site</h1>
+ <div class="pull-left"><div id="bannerLeft"><h2>Apache Jackrabbit Site</h2>
</div>
</div>
<div class="pull-right"></div>
@@ -112,7 +114,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2022-07-05</li>
+ <li id="publishDate">Last Published: 2022-05-09</li>
</ul>
</div>
</header>
@@ -136,7 +138,7 @@
<li><a href="jackrabbit-architecture.html" title="Jackrabbit Architecture"><span class="none"></span>Jackrabbit Architecture</a></li>
<li><a href="deployment-models.html" title="Deployment Models"><span class="none"></span>Deployment Models</a></li>
<li><a href="jackrabbit-configuration.html" title="Jackrabbit Configuration"><span class="none"></span>Jackrabbit Configuration</a></li>
- <li class="active"><a><span class="none"></span>Node Types</a></li>
+ <li class="active"><a href="#"><span class="none"></span>Node Types</a></li>
<li><a href="object-content-mapping.html" title="Object Content Mapping"><span class="none"></span>Object Content Mapping</a></li>
<li class="nav-header">Development</li>
<li><a href="jackrabbit-team.html" title="Jackrabbit Team"><span class="none"></span>Jackrabbit Team</a></li>
@@ -157,6 +159,7 @@
</ul>
</nav>
<div class="well sidebar-nav">
+ <hr />
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
@@ -183,11 +186,7 @@
limitations under the License.
-->
<h1>Node Types</h1>
-<p>Each node in a Jackrabbit workspace tree has a node type that defines the
-child nodes and properties it may (or must) have. Developers can use node
-types to define a custom content model for their application domain and
-have Jackrabbit enforce the constraints of that model at the repository
-level.</p>
+<p>Each node in a Jackrabbit workspace tree has a node type that defines the child nodes and properties it may (or must) have. Developers can use node types to define a custom content model for their application domain and have Jackrabbit enforce the constraints of that model at the repository level.</p>
<p>also see:</p>
<ul>
@@ -195,79 +194,38 @@ level.</p>
<li><a href="node-type-visualization.html">Node Type Visualization</a></li>
</ul><section>
<h2><a name="Primary_vs_Mixin"></a>Primary vs Mixin</h2>
-<p>There are two categories of node types, <i>primary</i> and <i>mixin</i>. Every node
-has a primary node type assigned to it upon creation (see <code>Node.addNode</code>
-in the JCR API). In addition, a mixin node type may be added to a node
-later in its lifecycle (see <i>Node.addMixin</i>).</p>
-<p>The primary node type of a node usually defines node structure (i.e.,
-allowed and required child nodes and properties) related to the problem
-domain being modeled. For example, a node used in storing content about
-business contacts might have the primary type <code>myapp:Contact</code> which
-defines properties such as <code>myapp:givenName</code>, <code>myapp:familyName</code> and so
-forth.</p>
-<p>Mixin node types usually specify additional properties or child nodes
-related to a capability being added to the node. These capabilities may
-include generic repository-level functions as in the case of the built-in
-mixins <code>mix:versionable</code> and <code>mix:lockable</code>, for example, or
-domain-level capabilities such as a (hypothetical) <code>myapp:Emailable</code>
-mixin type that adds the property <code>myapp:emailAddress</code> to a node.</p></section><section>
+<p>There are two categories of node types, <i>primary</i> and <i>mixin</i>. Every node has a primary node type assigned to it upon creation (see <code>Node.addNode</code> in the JCR API). In addition, a mixin node type may be added to a node later in its lifecycle (see <i>Node.addMixin</i>).</p>
+<p>The primary node type of a node usually defines node structure (i.e., allowed and required child nodes and properties) related to the problem domain being modeled. For example, a node used in storing content about business contacts might have the primary type <code>myapp:Contact</code> which defines properties such as <code>myapp:givenName</code>, <code>myapp:familyName</code> and so forth.</p>
+<p>Mixin node types usually specify additional properties or child nodes related to a capability being added to the node. These capabilities may include generic repository-level functions as in the case of the built-in mixins <code>mix:versionable</code> and <code>mix:lockable</code>, for example, or domain-level capabilities such as a (hypothetical) <code>myapp:Emailable</code> mixin type that adds the property <code>myapp:emailAddress</code> to a node.</p></section><section>
<h2><a name="Inheritance"></a>Inheritance</h2>
-<p>Primary node types are arranged in an inheritance hierarchy. Every primary
-node type must be the subtype of at least one existing node type. The
-built-in node type <code>nt:base</code> serves as the root of this hierarchy.
-Jackrabbit supports multiple inheritance of node types so node types can
-have more than one supertype.</p>
+<p>Primary node types are arranged in an inheritance hierarchy. Every primary node type must be the subtype of at least one existing node type. The built-in node type <code>nt:base</code> serves as the root of this hierarchy. Jackrabbit supports multiple inheritance of node types so node types can have more than one supertype.</p>
<p>Mixin node types do not have to have supertypes.</p>
-<p>The JSR 170 specification and the current public review draft of the JSR
-283 specification (section 4.7.7) leave it up to the implementation whether
-e.g. the orderable child nodes setting is inherited from supertypes.
-Inheritance semantics, especially with multiple inheritance, are
-non-trivial at best and up to a certain degree arbitrary. Jackrabbit
-therefore, in compliance with the spec, doesn't support inheritance of node
-type attributes such as orderable.</p></section><section>
+<p>The JSR 170 specification and the current public review draft of the JSR 283 specification (section 4.7.7) leave it up to the implementation whether e.g. the orderable child nodes setting is inherited from supertypes. Inheritance semantics, especially with multiple inheritance, are non-trivial at best and up to a certain degree arbitrary. Jackrabbit therefore, in compliance with the spec, doesn’t support inheritance of node type attributes such as orderable.</p></section><section>
<h2><a name="Node_Type_Definition"></a>Node Type Definition</h2>
<p>A node type definition has the following attributes:</p>
<ul>
<li><b>Name</b><br />
-Every node type registered with the repository has a unique name.
-The naming conventions for node types are the same as
-for items (i.e., they may have a colon delimited prefix).</li>
+Every node type registered with the repository has a unique name. The naming conventions for node types are the same as for items (i.e., they may have a colon delimited prefix).</li>
<li><b>Supertypes</b><br />
-A primary node type (with the exception of <i>nt:base</i>) must
-extend another node type (and may extend more than one node type). A mixin
-node type may extend another node type.</li>
+A primary node type (with the exception of <i>nt:base</i>) must extend another node type (and may extend more than one node type). A mixin node type may extend another node type.</li>
<li><b>Mixin Status</b><br />
A node type may be either primary or mixin.</li>
<li><b>Orderable Child Nodes Status</b><br />
-A primary node type may specify that child
-nodes are client-orderable. If this status is set to true, then
-<code>Node.orderBefore</code> can be used to set the order of child nodes. Only
-primary node types control a node's status in this regard. This setting on
-a mixin node type will not have any effect on the node.</li>
+A primary node type may specify that child nodes are client-orderable. If this status is set to true, then <code>Node.orderBefore</code> can be used to set the order of child nodes. Only primary node types control a node’s status in this regard. This setting on a mixin node type will not have any effect on the node.</li>
<li><b>Property Definitions</b><br />
-A node type contains a set of definitions
-specifying the properties that nodes of this node type are allowed (or
-required) to have and the characteristics of those properties (see below).</li>
+A node type contains a set of definitions specifying the properties that nodes of this node type are allowed (or required) to have and the characteristics of those properties (see below).</li>
<li><b>Child Node Definitions</b><br />
-A node type contains a set of definitions
-specifying the child nodes that nodes of this node type are allowed (or
-required) to have and the characteristics of those child nodes (including,
-in turn, their node types, see below).</li>
+A node type contains a set of definitions specifying the child nodes that nodes of this node type are allowed (or required) to have and the characteristics of those child nodes (including, in turn, their node types, see below).</li>
<li><b>Primary Item Name</b><br />
-A node type may specify one child item (property or
-node) by name as the primary item. This indicator is used by the method
-<code>Node.getPrimaryItem()</code>.</li>
+A node type may specify one child item (property or node) by name as the primary item. This indicator is used by the method <code>Node.getPrimaryItem()</code>.</li>
</ul></section><section>
<h2><a name="Property_Definition"></a>Property Definition</h2>
-<p>A property definition (within a node type definition) contains the the
-following information:</p>
+<p>A property definition (within a node type definition) contains the the following information:</p>
<ul>
<li><b>Name</b><br />
-The name of the property to which this definition applies, or <code>*</code> if this definition is a "residual
-definition', meaning that it applies to any additional properties with any
-names apart from those otherwise defined in this node type.</li>
+The name of the property to which this definition applies, or <code>*</code> if this definition is a "residual definition’, meaning that it applies to any additional properties with any names apart from those otherwise defined in this node type.</li>
<li><b>Required Type</b><br />
The required type of the property. One of
<ul>
@@ -285,86 +243,47 @@ The required type of the property. One o
</ul>
</li>
<li><b>Value Constraints</b><br />
-The value constraints on the property define the
-range of values that may be assigned to this property.</li>
+The value constraints on the property define the range of values that may be assigned to this property.</li>
<li><b>Default Value</b><br />
The value that the property will have if it is auto-created.</li>
<li><b>Auto-create Status</b><br />
-Whether this property will be auto-created when its
-parent node is created. Only properties with a default value can be
-auto-created.</li>
+Whether this property will be auto-created when its parent node is created. Only properties with a default value can be auto-created.</li>
<li><b>Mandatory Status</b><br />
-A mandatory property is one that must exist. If a node
-of a type that specifies a mandatory property is
-created then any attempt to save that node without adding the mandatory
-property will fail. Since single-value properties either have a value or do
-not exist (there being no concept of the null value) this implies that a
-mandatory single-value property must have a value. A mandatory multi-value
-property on the other hand may have zero or more values.</li>
+A mandatory property is one that must exist. If a node of a type that specifies a mandatory property is created then any attempt to save that node without adding the mandatory property will fail. Since single-value properties either have a value or do not exist (there being no concept of the null value) this implies that a mandatory single-value property must have a value. A mandatory multi-value property on the other hand may have zero or more values.</li>
<li><b>On-Parent-Version Status</b><br />
-The <code>onParentVersion</code> status of specifies what happens to this property if a
-new version of its parent node is created (i.e. a checked-in is done on it).</li>
+The <code>onParentVersion</code> status of specifies what happens to this property if a new version of its parent node is created (i.e. a checked-in is done on it).</li>
<li><b>Protected Status</b><br />
-A protected property is one which cannot be modified
-(i.e. have child nodes or properties added or removed) or removed from its
-parent through the JCR API.</li>
+A protected property is one which cannot be modified (i.e. have child nodes or properties added or removed) or removed from its parent through the JCR API.</li>
<li><b>Multiple Values Status</b><br />
-Whether this property can have multiple values,
-meaning that it stores an array of values, not just one. Note that this
-“multiple values” flag is special in that a given node type may have two
-property definitions that are identical in every respect except for the
-their “multiple values” status. For example, a node type can specify two
-string properties both called X, one of which is multi-valued and the other
-that is not. An example of such a node type is <code>nt:unstructured</code>.</li>
+Whether this property can have multiple values, meaning that it stores an array of values, not just one. Note that this “multiple values” flag is special in that a given node type may have two property definitions that are identical in every respect except for the their “multiple values” status. For example, a node type can specify two string properties both called X, one of which is multi-valued and the other that is not. An example of such a node type is <code>nt:unstructured</code>.</li>
</ul></section><section>
<h2><a name="Child_Node_Definition"></a>Child Node Definition</h2>
-<p>A child node definition (within a node type definition) contains the the
-following information:</p>
+<p>A child node definition (within a node type definition) contains the the following information:</p>
<ul>
<li><b>Name</b><br />
-The name of the child node to which this definition applies or <code>*</code> if this
-definition is a "residual definition', meaning that it applies to any
-additional child nodes with any names apart from those otherwise defined in this node type.</li>
+The name of the child node to which this definition applies or <code>*</code> if this definition is a "residual definition’, meaning that it applies to any additional child nodes with any names apart from those otherwise defined in this node type.</li>
<li><b>Required Primary Types</b><br />
-If it specifies only a single node type N then
-the primary node type of this child node must be N or a subtype of N. If
-this attribute specifies multiple node types N1, N2,…, Nm then the
-primary node type of this child node must be a subtype of all the types N1,
-N2, … Nm. Note that this is possible because
-Jackrabbit supports multiple inheritance among node types and that each
-node still has one and only one primary node type.</li>
+If it specifies only a single node type N then the primary node type of this child node must be N or a subtype of N. If this attribute specifies multiple node types N1, N2,…, Nm then the primary node type of this child node must be a subtype of all the types N1, N2, … Nm. Note that this is possible because Jackrabbit supports multiple inheritance among node types and that each node still has one and only one primary node type.</li>
<li><b>Default Primary Type</b><br />
-This is the primary node type automatically
-assigned if no node type information is specified when the node is created.</li>
+This is the primary node type automatically assigned if no node type information is specified when the node is created.</li>
<li><b>Auto-create Status</b><br />
Governs whether this child node will be auto-created when its parent node is created.</li>
<li><b>Mandatory Status</b><br />
-Governs whether the child node is mandatory. A
-mandatory child node is one that must exist. If a mandatory child node is
-missing from a parent node then save on the parent node will fail.</li>
+Governs whether the child node is mandatory. A mandatory child node is one that must exist. If a mandatory child node is missing from a parent node then save on the parent node will fail.</li>
<li><b>On-Parent-Version Status</b><br />
This specifies what to do with the child node if its parent node is versioned.</li>
<li><b>Protected Status</b><br />
-This governs whether the child node is protected. A
-protected node is one which cannot be modified (have child node or
-properties added to it or removed from it) or be removed from its parent through the JCR API.</li>
+This governs whether the child node is protected. A protected node is one which cannot be modified (have child node or properties added to it or removed from it) or be removed from its parent through the JCR API.</li>
<li><b>Same-Name Siblings Status</b><br />
-This governs whether this child node can have
-same-name siblings, meaning that the parent node can have more than one
-child node of this name.</li>
+This governs whether this child node can have same-name siblings, meaning that the parent node can have more than one child node of this name.</li>
</ul></section><section>
<h2><a name="Registering_Node_Types"></a>Registering Node Types</h2>
-<p>Each Jackrabbit instance has a <i>NodeTypeRegistry</i> which is created on
-start-up and populated with the set of built-in node types (these include
-both those required by the JCR specification and others required by the
-Jackrabbit implementation).</p>
-<p>First you define your node types in a text file using the “Compact
-Namespace and Node Type Definition” (CND) notation, then register them
-using the <a class="externalLink" href="http://jackrabbit.apache.org/api/1.5/org/apache/jackrabbit/api/JackrabbitNodeTypeManager.html"><i>JackrabbitNodeTypeManager</i></a>.
-The following code gives an example:</p>
+<p>Each Jackrabbit instance has a <i>NodeTypeRegistry</i> which is created on start-up and populated with the set of built-in node types (these include both those required by the JCR specification and others required by the Jackrabbit implementation).</p>
+<p>First you define your node types in a text file using the “Compact Namespace and Node Type Definition” (CND) notation, then register them using the <a class="externalLink" href="http://jackrabbit.apache.org/api/1.5/org/apache/jackrabbit/api/JackrabbitNodeTypeManager.html"><i>JackrabbitNodeTypeManager</i></a>. The following code gives an example:</p>
-<div class="source"><pre class="prettyprint linenums"><code>import javax.jcr.Session;
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">import javax.jcr.Session;
import org.apache.jackrabbit.api.JackrabbitNodeTypeManager;
import java.io.FileInputStream;
@@ -380,7 +299,8 @@ public class CustomNodeTypeExample {
manager.registerNodeTypes(new FileInputStream(cndFileName), JackrabbitNodeTypeManager.TEXT_X_JCR_CND);
}
}
-</code></pre></div>
+</pre></div></div>
+
<p>Continue to <a href="node-type-notation.html">Node Type Notation</a> or <a href="node-type-visualization.html">Node Type Visualization</a></p></section>
</main>
</div>
@@ -393,12 +313,10 @@ public class CustomNodeTypeExample {
<a href="https://www.apache.org/">The Apache Software Foundation</a> | <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a>
</p>
</div>
- </div>
+ <div id="ohloh" class="pull-right">
+ <script src="https://www.ohloh.net/p/jackrabbit/widgets/project_users_logo.js"></script>
+ </div>
+ </div>
</footer>
-<script>
- if(anchors) {
- anchors.add();
- }
-</script>
</body>
</html>
\ No newline at end of file