FastInfosetSerializer


1   /*
2    * Fast Infoset ver. 0.1 software ("Software")
3    * 
4    * Copyright, 2004-2005 Sun Microsystems, Inc. All Rights Reserved. 
5    * 
6    * Software is licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License. You may
8    * obtain a copy of the License at:
9    * 
10   *        http://www.apache.org/licenses/LICENSE-2.0
11   * 
12   *    Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15   * License for the specific language governing permissions and limitations.
16   * 
17   *    Sun supports and benefits from the global community of open source
18   * developers, and thanks the community for its important contributions and
19   * open standards-based technology, which Sun has adopted into many of its
20   * products.
21   * 
22   *    Please note that portions of Software may be provided with notices and
23   * open source licenses from such communities and third parties that govern the
24   * use of those portions, and any licenses granted hereunder do not alter any
25   * rights and obligations you may have under such open source licenses,
26   * however, the disclaimer of warranty and limitation of liability provisions
27   * in this License will apply to all Software in this distribution.
28   * 
29   *    You acknowledge that the Software is not designed, licensed or intended
30   * for use in the design, construction, operation or maintenance of any nuclear
31   * facility.
32   *
33   * Apache License
34   * Version 2.0, January 2004
35   * http://www.apache.org/licenses/
36   *
37   */
38  
39  
40  package org.jvnet.fastinfoset;
41  
42  import java.util.Map  ;
43  
44  /**
45   *
46   * @author Paul.Sandoz@Sun.Com
47   */
48  public interface FastInfosetSerializer {
49      /**
50       * The default value for the limit on the size of character content chunks
51       * that will be indexed.
52       */
53      public final static int CHARACTER_CONTENT_CHUNK_SIZE_CONSTRAINT = 7;
54      
55      /**
56       * The default value for the limit on the size of attribute values
57       * that will be indexed.
58       */
59      public final static int ATTRIBUTE_VALUE_SIZE_CONSTRAINT = 7;
60      
61      /**
62       * The character encoding scheme string for UTF-8
63       */
64      public static final String   UTF_8 = "UTF-8";
65      
66      /**
67       * The character encoding scheme string for UTF-16BE
68       */
69      public static final String   UTF_16BE = "UTF-16BE";
70      
71      /**
72       * Sets the character encoding scheme.
73       *
74       * The character encoding can be either UTF-8 or UTF-16BE for the
75       * the encoding of chunks of CIIs, the [normalized value]
76       * property of attribute information items, comment information
77       * items and processing instruction information items.
78       *
79       * @param characterEncodingScheme The set of registered algorithms.
80       */
81      public void setCharacterEncodingScheme(String   characterEncodingScheme);
82      
83      /**
84       * Gets the character encoding scheme.
85       *
86       * @return The character encoding scheme.
87       */
88      public String   getCharacterEncodingScheme();
89      
90      /**
91       * Sets the set of registered encoding algorithms.
92       *
93       * @param algorithms The set of registered algorithms.
94       */
95      public void setRegisteredEncodingAlgorithms(Map   algorithms);
96      
97      /**
98       * Gets the set of registered encoding algorithms.
99       *
100      * @return The set of registered algorithms.
101      */
102     public Map   getRegisteredEncodingAlgorithms();
103     
104     /**
105      * Sets the limit on the size of character content chunks
106      * that will be indexed.
107      *
108      * @param size The character content chunk size limit. Any chunk less
109      * that a length of size limit will be indexed.
110      */
111     public void setCharacterContentChunkSizeLimit(int size);
112     
113     /**
114      * Gets the limit on the size of character content chunks
115      * that will be indexed.
116      *
117      * @return The character content chunk size limit.
118      */
119     public int getCharacterContentChunkSizeLimit();
120 
121     /**
122      * Sets the limit on the size of attribute values
123      * that will be indexed.
124      *
125      * @param size The attribute value size limit. Any value less
126      * that a length of size limit will be indexed.
127      */
128     public void setAttributeValueSizeLimit(int size);
129     
130     /**
131      * Gets the limit on the size of attribute values
132      * that will be indexed.
133      *
134      * @return The attribute value size limit.
135      */
136     public int getAttributeValueSizeLimit();
137     
138     
139     // Before serializing
140     
141     public void setExternalVocabulary(ReferencedVocabulary referencedVocabulary);
142     
143     public void setIntitialVocabulary(Vocabulary initialVocabulary);
144     
145     public void setDynamicVocabulary(Vocabulary dynamicVocabulary);
146 
147     
148     // After serializing
149 
150     public Vocabulary getDynamicVocabulary();
151 
152     public Vocabulary getFinalVocabulary();    
153 }
154
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags