DataTypeDefinition


1   /*
2    * Copyright (C) 2005 Alfresco, Inc.
3    *
4    * Licensed under the Mozilla Public License version 1.1 
5    * with a permitted attribution clause. You may obtain a
6    * copy of the License at
7    *
8    *   http://www.alfresco.org/legal/license.txt
9    *
10   * Unless required by applicable law or agreed to in writing,
11   * software distributed under the License is distributed on an
12   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13   * either express or implied. See the License for the specific
14   * language governing permissions and limitations under the
15   * License.
16   */
17  package org.alfresco.service.cmr.dictionary;
18  
19  import java.util.Locale  ;
20  
21  import org.alfresco.service.namespace.NamespaceService;
22  import org.alfresco.service.namespace.QName;
23  
24  
25  /**
26   * Read-only definition of a Data Type
27   * 
28   * @author David Caruana
29   */
30  public interface DataTypeDefinition
31  {
32      //
33      // Built-in Property Types
34      //
35      public QName ANY = QName.createQName(NamespaceService.DICTIONARY_MODEL_1_0_URI, "any");
36      public QName TEXT = QName.createQName(NamespaceService.DICTIONARY_MODEL_1_0_URI, "text");
37      public QName CONTENT = QName.createQName(NamespaceService.DICTIONARY_MODEL_1_0_URI, "content");
38      public QName INT = QName.createQName(NamespaceService.DICTIONARY_MODEL_1_0_URI, "int");
39      public QName LONG = QName.createQName(NamespaceService.DICTIONARY_MODEL_1_0_URI, "long");
40      public QName FLOAT = QName.createQName(NamespaceService.DICTIONARY_MODEL_1_0_URI, "float");
41      public QName DOUBLE = QName.createQName(NamespaceService.DICTIONARY_MODEL_1_0_URI, "double");
42      public QName DATE = QName.createQName(NamespaceService.DICTIONARY_MODEL_1_0_URI, "date");
43      public QName DATETIME = QName.createQName(NamespaceService.DICTIONARY_MODEL_1_0_URI, "datetime");
44      public QName BOOLEAN = QName.createQName(NamespaceService.DICTIONARY_MODEL_1_0_URI, "boolean");
45      public QName QNAME = QName.createQName(NamespaceService.DICTIONARY_MODEL_1_0_URI, "qname");
46      public QName CATEGORY = QName.createQName(NamespaceService.DICTIONARY_MODEL_1_0_URI, "category");
47      public QName NODE_REF = QName.createQName(NamespaceService.DICTIONARY_MODEL_1_0_URI, "noderef");
48      public QName PATH = QName.createQName(NamespaceService.DICTIONARY_MODEL_1_0_URI, "path");
49      
50      
51      /**
52       * @return defining model
53       */
54      public ModelDefinition getModel();
55      
56      /**
57       * @return the qualified name of the data type
58       */
59      public QName getName();
60      
61      /**
62       * @return the human-readable class title 
63       */
64      public String   getTitle();
65      
66      /**
67       * @return the human-readable class description 
68       */
69      public String   getDescription();
70  
71      /**
72       * @return the indexing analyser class
73       */
74      public String   getAnalyserClassName();
75      
76      /**
77       * @return the indexing analyser class for the specified locale
78       */
79      public String   getAnalyserClassName(Locale   locale);
80      
81      /**
82       * @return the equivalent java class name (or null, if not mapped) 
83       */
84      public String   getJavaClassName();
85      
86  }
87
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags