blob: 3d4fbbff9b40dff5be019af3e661e8a24543c0b6 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>InMemorySecondaryTypeDefinition xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/chemistry/opencmis/inmemory/types/InMemorySecondaryTypeDefinition.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.chemistry.opencmis.inmemory.types;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="23" href="#23">23</a>
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.definitions.PropertyDefinition;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.enums.BaseTypeId;
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.exceptions.CmisInvalidArgumentException;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.impl.dataobjects.SecondaryTypeDefinitionImpl;
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.impl.dataobjects.TypeMutabilityImpl;
<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.inmemory.NameValidator;
<a class="jxr_linenumber" name="30" href="#30">30</a>
<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/chemistry/opencmis/inmemory/types/InMemorySecondaryTypeDefinition.html">InMemorySecondaryTypeDefinition</a> <strong class="jxr_keyword">extends</strong> SecondaryTypeDefinitionImpl {
<a class="jxr_linenumber" name="32" href="#32">32</a>
<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 1L;
<a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/chemistry/opencmis/inmemory/types/InMemorySecondaryTypeDefinition.html">InMemorySecondaryTypeDefinition</a> SECONDARY_TYPE = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/chemistry/opencmis/inmemory/types/InMemorySecondaryTypeDefinition.html">InMemorySecondaryTypeDefinition</a>();
<a class="jxr_linenumber" name="35" href="#35">35</a>
<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/chemistry/opencmis/inmemory/types/InMemorySecondaryTypeDefinition.html">InMemorySecondaryTypeDefinition</a> getRootSecondaryType() {
<a class="jxr_linenumber" name="37" href="#37">37</a> <strong class="jxr_keyword">return</strong> SECONDARY_TYPE;
<a class="jxr_linenumber" name="38" href="#38">38</a> }
<a class="jxr_linenumber" name="39" href="#39">39</a>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_comment">/*<em class="jxr_comment"> This constructor is just for creating the root document */</em></em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/chemistry/opencmis/inmemory/types/InMemorySecondaryTypeDefinition.html">InMemorySecondaryTypeDefinition</a>() {
<a class="jxr_linenumber" name="42" href="#42">42</a> init(BaseTypeId.CMIS_SECONDARY.value(), <span class="jxr_string">"Secondary Type"</span>, <strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="43" href="#43">43</a> setParentTypeId(<strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="44" href="#44">44</a> }
<a class="jxr_linenumber" name="45" href="#45">45</a>
<a class="jxr_linenumber" name="46" href="#46">46</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/chemistry/opencmis/inmemory/types/InMemorySecondaryTypeDefinition.html">InMemorySecondaryTypeDefinition</a>(String id, String displayName) {
<a class="jxr_linenumber" name="47" href="#47">47</a> init(id, displayName, false);
<a class="jxr_linenumber" name="48" href="#48">48</a> setParentTypeId(SECONDARY_TYPE.getId());
<a class="jxr_linenumber" name="49" href="#49">49</a> }
<a class="jxr_linenumber" name="50" href="#50">50</a>
<a class="jxr_linenumber" name="51" href="#51">51</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/chemistry/opencmis/inmemory/types/InMemorySecondaryTypeDefinition.html">InMemorySecondaryTypeDefinition</a>(String id, String displayName, <a href="../../../../../../org/apache/chemistry/opencmis/inmemory/types/InMemoryDocumentTypeDefinition.html">InMemoryDocumentTypeDefinition</a> parentType) {
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_comment">// get root type</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> init(id, displayName, false);
<a class="jxr_linenumber" name="54" href="#54">54</a> <strong class="jxr_keyword">if</strong> (parentType != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="55" href="#55">55</a> setBaseTypeId(parentType.getBaseTypeId());
<a class="jxr_linenumber" name="56" href="#56">56</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="57" href="#57">57</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Must provide a parent type when creating a document type definition"</span>);
<a class="jxr_linenumber" name="58" href="#58">58</a> }
<a class="jxr_linenumber" name="59" href="#59">59</a> setParentTypeId(parentType.getId());
<a class="jxr_linenumber" name="60" href="#60">60</a> }
<a class="jxr_linenumber" name="61" href="#61">61</a>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * Set the property definitions for this type. The parameter</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * propertyDefinitions should only contain the custom property definitions</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * for this type. The standard property definitions are added automatically.</em>
<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @see org.apache.opencmis.commons.impl.dataobjects.AbstractTypeDefinition#</em>
<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * setPropertyDefinitions(java.util.Map)</em>
<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="70" href="#70">70</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addCustomPropertyDefinitions(Map&lt;String, PropertyDefinition&lt;?&gt;&gt; propertyDefinitions) {
<a class="jxr_linenumber" name="71" href="#71">71</a> DocumentTypeCreationHelper.mergePropertyDefinitions(getPropertyDefinitions(), propertyDefinitions);
<a class="jxr_linenumber" name="72" href="#72">72</a> }
<a class="jxr_linenumber" name="73" href="#73">73</a>
<a class="jxr_linenumber" name="74" href="#74">74</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> init(String id, String displayName, <strong class="jxr_keyword">boolean</strong> isBaseType) {
<a class="jxr_linenumber" name="75" href="#75">75</a> <strong class="jxr_keyword">if</strong> (!NameValidator.isValidId(id)) {
<a class="jxr_linenumber" name="76" href="#76">76</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> CmisInvalidArgumentException(NameValidator.ERROR_ILLEGAL_ID);
<a class="jxr_linenumber" name="77" href="#77">77</a> }
<a class="jxr_linenumber" name="78" href="#78">78</a>
<a class="jxr_linenumber" name="79" href="#79">79</a> setBaseTypeId(BaseTypeId.CMIS_SECONDARY);
<a class="jxr_linenumber" name="80" href="#80">80</a> setId(id);
<a class="jxr_linenumber" name="81" href="#81">81</a> <strong class="jxr_keyword">if</strong> (displayName == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="82" href="#82">82</a> displayName = id;
<a class="jxr_linenumber" name="83" href="#83">83</a> }
<a class="jxr_linenumber" name="84" href="#84">84</a> setDisplayName(displayName);
<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_comment">// create some suitable defaults for convenience</em>
<a class="jxr_linenumber" name="86" href="#86">86</a> setDescription(<span class="jxr_string">"Description of "</span> + getDisplayName() + <span class="jxr_string">" Type"</span>);
<a class="jxr_linenumber" name="87" href="#87">87</a> setLocalName(id);
<a class="jxr_linenumber" name="88" href="#88">88</a> setLocalNamespace(<strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="89" href="#89">89</a> setQueryName(id);
<a class="jxr_linenumber" name="90" href="#90">90</a> setIsControllableAcl(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="91" href="#91">91</a> setIsControllablePolicy(false);
<a class="jxr_linenumber" name="92" href="#92">92</a> setIsCreatable(false);
<a class="jxr_linenumber" name="93" href="#93">93</a> setIsFileable(false);
<a class="jxr_linenumber" name="94" href="#94">94</a> setIsFulltextIndexed(false);
<a class="jxr_linenumber" name="95" href="#95">95</a> setIsIncludedInSupertypeQuery(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="96" href="#96">96</a> setIsQueryable(false);
<a class="jxr_linenumber" name="97" href="#97">97</a>
<a class="jxr_linenumber" name="98" href="#98">98</a> TypeMutabilityImpl typeMutability = <strong class="jxr_keyword">new</strong> TypeMutabilityImpl();
<a class="jxr_linenumber" name="99" href="#99">99</a> typeMutability.setCanCreate(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="100" href="#100">100</a> typeMutability.setCanDelete(!isBaseType);
<a class="jxr_linenumber" name="101" href="#101">101</a> typeMutability.setCanUpdate(!isBaseType);
<a class="jxr_linenumber" name="102" href="#102">102</a> setTypeMutability (typeMutability);
<a class="jxr_linenumber" name="103" href="#103">103</a>
<a class="jxr_linenumber" name="104" href="#104">104</a> Map&lt;String, PropertyDefinition&lt;?&gt;&gt; props = <strong class="jxr_keyword">new</strong> HashMap&lt;String, PropertyDefinition&lt;?&gt;&gt;();
<a class="jxr_linenumber" name="105" href="#105">105</a> setPropertyDefinitions(props); <em class="jxr_comment">// set initial empty set of properties</em>
<a class="jxr_linenumber" name="106" href="#106">106</a>
<a class="jxr_linenumber" name="107" href="#107">107</a> }
<a class="jxr_linenumber" name="108" href="#108">108</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>