blob: 0dc0c35f313f59b7e1613c771e1231c8614c7706 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
/**
*
* 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. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.tuscany.sdo.helper;
import java.util.Map;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;
import commonj.sdo.DataObject;
import commonj.sdo.helper.XMLDocument;
/**
* Helper interface for reading and writing SDO DataObjects from XML streams (StAX).
*
* @version $Rev$ $Date$
*/
public interface XMLStreamHelper {
/**
* Creates and returns an XMLDocument from an XML input stream.
* The reader must be positioned on a START_DOCUMENT event.
*
* @param reader the stream to read
* @return an XMLDocument created from the stream
* @throws XMLStreamException if there was a problem reading the stream
* @throws IllegalStateException if the reader is not positioned on a START_DOCUMENT event
*/
XMLDocument load(XMLStreamReader reader) throws XMLStreamException, IllegalStateException;
/**
* Save a XMLDocument to an XML stream.
*
* @param document the document to be written
* @param writer the stream to write to
* @throws XMLStreamException if there was a problem writing to the stream
*/
void save(XMLDocument document, XMLStreamWriter writer) throws XMLStreamException;
/**
* Creates and returns a XMLStreamReader that can be used to read an XMLDocument as a XML event stream.
* The reader will be positioned on a START_DOCUMENT event.
*
* @param document the XMLDocument to be read
* @return an XMLStreamReader that can be used to read the document
*/
XMLStreamReader createXMLStreamReader(XMLDocument document) throws XMLStreamException;
/**
* Create a DataObject from an element in a XML stream.
* The reader must be positioned on a START_ELEMENT event.
*
* @param reader the stream to read
* @return a DataObject created from the element in the stream
* @throws XMLStreamException if there was a problem reading the stream
* @throws IllegalStateException if the reader is not positioned on a START_ELEMENT event
*/
DataObject loadObject(XMLStreamReader reader) throws XMLStreamException, IllegalStateException;
/**
* Default Type to load DataObject if the element is unqualified/local without xsi:type
* or the qualified/global element or xsi:type fail to resolve.
* Can be null.
*/
String OPTION_DEFAULT_ROOT_TYPE = "default root type";
/**
* Create a DataObject from an element in a XML stream.
* The reader must be positioned on a START_ELEMENT event.
*
* @param reader the stream to read
* @param options {@link OPTION_DEFAULT_ROOT_TYPE}; can be null or empty
* @return a DataObject created from the element in the stream
* @throws XMLStreamException if there was a problem reading the stream
* @throws IllegalStateException if the reader is not positioned on a START_ELEMENT event
*/
DataObject loadObject(XMLStreamReader reader, Map options) throws XMLStreamException, IllegalStateException;
/**
* Save a DataObject to an XML stream.
*
* @param sdo the DataObject to be written
* @param writer the stream to write to
* @throws XMLStreamException if there was a problem writing to the stream
*/
void saveObject(DataObject sdo, XMLStreamWriter writer) throws XMLStreamException;
/**
* Creates and returns a XMLStreamReader that can be used to read a DataObject as a XML event stream.
* The reader will be positioned on a START_ELEMENT event.
*
* @param sdo the DataObject to be read
* @return an XMLStreamReader that can be used to read the DataObject
*/
XMLStreamReader createXMLStreamReader(DataObject sdo);
}
|
