Revision 1322
org.gvsig.xmlpull/library/tags/org.gvsig.xmlpull-2.0.33/org.gvsig.xmlpull.lib/org.gvsig.xmlpull.lib.impl/src/main/java/org/gvsig/xmlpull/lib/impl/CreateXmlStreamReaderException.java | ||
---|---|---|
1 |
/* gvSIG. Geographic Information System of the Valencian Government |
|
2 |
* |
|
3 |
* Copyright (C) 2007-2008 Infrastructures and Transports Department |
|
4 |
* of the Valencian Government (CIT) |
|
5 |
* |
|
6 |
* This program is free software; you can redistribute it and/or |
|
7 |
* modify it under the terms of the GNU General Public License |
|
8 |
* as published by the Free Software Foundation; either version 2 |
|
9 |
* of the License, or (at your option) any later version. |
|
10 |
* |
|
11 |
* This program is distributed in the hope that it will be useful, |
|
12 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
13 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
14 |
* GNU General Public License for more details. |
|
15 |
* |
|
16 |
* You should have received a copy of the GNU General Public License |
|
17 |
* along with this program; if not, write to the Free Software |
|
18 |
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, |
|
19 |
* MA 02110-1301, USA. |
|
20 |
* |
|
21 |
*/ |
|
22 |
|
|
23 |
/* |
|
24 |
* AUTHORS (In addition to CIT): |
|
25 |
* 2009 {gvSIG} {{Task}} |
|
26 |
*/ |
|
27 |
package org.gvsig.xmlpull.lib.impl; |
|
28 |
|
|
29 |
import org.gvsig.tools.exception.BaseRuntimeException; |
|
30 |
import org.gvsig.xmlpull.lib.api.stream.IXmlStreamReader; |
|
31 |
|
|
32 |
/** |
|
33 |
* Exception thrown when there is an error creating a new {@link IXmlStreamReader}. |
|
34 |
* |
|
35 |
* @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a> |
|
36 |
*/ |
|
37 |
public class CreateXmlStreamReaderException extends |
|
38 |
BaseRuntimeException { |
|
39 |
private static final long serialVersionUID = -8220667598288924597L; |
|
40 |
|
|
41 |
private final static String MESSAGE_FORMAT = "Exception creating the xml stream reader with " + |
|
42 |
"mimeType '%(mimeType)'."; |
|
43 |
private final static String MESSAGE_KEY = "_CreateXMLStreamReaderException"; |
|
44 |
|
|
45 |
public CreateXmlStreamReaderException(String mimeType, Throwable cause){ |
|
46 |
super(MESSAGE_FORMAT, cause, MESSAGE_KEY, serialVersionUID); |
|
47 |
setValue("mimeType", mimeType); |
|
48 |
} |
|
49 |
} |
|
0 | 50 |
org.gvsig.xmlpull/library/tags/org.gvsig.xmlpull-2.0.33/org.gvsig.xmlpull.lib/org.gvsig.xmlpull.lib.impl/src/main/java/org/gvsig/xmlpull/lib/impl/DefaultXmlPullLibrary.java | ||
---|---|---|
1 |
/* gvSIG. Geographic Information System of the Valencian Government |
|
2 |
* |
|
3 |
* Copyright (C) 2007-2008 Infrastructures and Transports Department |
|
4 |
* of the Valencian Government (CIT) |
|
5 |
* |
|
6 |
* This program is free software; you can redistribute it and/or |
|
7 |
* modify it under the terms of the GNU General Public License |
|
8 |
* as published by the Free Software Foundation; either version 2 |
|
9 |
* of the License, or (at your option) any later version. |
|
10 |
* |
|
11 |
* This program is distributed in the hope that it will be useful, |
|
12 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
13 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
14 |
* GNU General Public License for more details. |
|
15 |
* |
|
16 |
* You should have received a copy of the GNU General Public License |
|
17 |
* along with this program; if not, write to the Free Software |
|
18 |
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, |
|
19 |
* MA 02110-1301, USA. |
|
20 |
* |
|
21 |
*/ |
|
22 |
|
|
23 |
/* |
|
24 |
* AUTHORS (In addition to CIT): |
|
25 |
* 2009 {Iver T.I.} {Task} |
|
26 |
*/ |
|
27 |
|
|
28 |
package org.gvsig.xmlpull.lib.impl; |
|
29 |
|
|
30 |
import org.gvsig.tools.library.AbstractLibrary; |
|
31 |
import org.gvsig.tools.library.LibraryException; |
|
32 |
import org.gvsig.xmlpull.lib.api.XmlPullLibrary; |
|
33 |
import org.gvsig.xmlpull.lib.api.XmlPullLocator; |
|
34 |
import org.gvsig.xmlpull.lib.spi.XmlPullProviderLocator; |
|
35 |
|
|
36 |
/** |
|
37 |
* @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a> |
|
38 |
*/ |
|
39 |
public class DefaultXmlPullLibrary extends AbstractLibrary { |
|
40 |
|
|
41 |
public void doRegistration() { |
|
42 |
registerAsImplementationOf(XmlPullLibrary.class); |
|
43 |
} |
|
44 |
|
|
45 |
protected void doInitialize() throws LibraryException { |
|
46 |
XmlPullLocator.registerXMLManager(DefaultXmlPullManager.class); |
|
47 |
XmlPullProviderLocator.registerXMLProviderManager(DefaultXmlPullProviderManager.class); |
|
48 |
} |
|
49 |
|
|
50 |
protected void doPostInitialize() throws LibraryException { |
|
51 |
// Nothing to do |
|
52 |
} |
|
53 |
} |
|
0 | 54 |
org.gvsig.xmlpull/library/tags/org.gvsig.xmlpull-2.0.33/org.gvsig.xmlpull.lib/org.gvsig.xmlpull.lib.impl/src/main/java/org/gvsig/xmlpull/lib/impl/DefaultXmlPullProviderManager.java | ||
---|---|---|
1 |
/* gvSIG. Geographic Information System of the Valencian Government |
|
2 |
* |
|
3 |
* Copyright (C) 2007-2008 Infrastructures and Transports Department |
|
4 |
* of the Valencian Government (CIT) |
|
5 |
* |
|
6 |
* This program is free software; you can redistribute it and/or |
|
7 |
* modify it under the terms of the GNU General Public License |
|
8 |
* as published by the Free Software Foundation; either version 2 |
|
9 |
* of the License, or (at your option) any later version. |
|
10 |
* |
|
11 |
* This program is distributed in the hope that it will be useful, |
|
12 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
13 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
14 |
* GNU General Public License for more details. |
|
15 |
* |
|
16 |
* You should have received a copy of the GNU General Public License |
|
17 |
* along with this program; if not, write to the Free Software |
|
18 |
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, |
|
19 |
* MA 02110-1301, USA. |
|
20 |
* |
|
21 |
*/ |
|
22 |
|
|
23 |
/* |
|
24 |
* AUTHORS (In addition to CIT): |
|
25 |
* 2010 {Iver T.I.} {Task} |
|
26 |
*/ |
|
27 |
|
|
28 |
package org.gvsig.xmlpull.lib.impl; |
|
29 |
|
|
30 |
import java.io.InputStream; |
|
31 |
import java.io.OutputStream; |
|
32 |
import java.util.ArrayList; |
|
33 |
import java.util.Collections; |
|
34 |
import java.util.Iterator; |
|
35 |
import java.util.List; |
|
36 |
|
|
37 |
import org.gvsig.xmlpull.lib.api.stream.IXmlStreamReader; |
|
38 |
import org.gvsig.xmlpull.lib.api.stream.IXmlStreamReaderFactory; |
|
39 |
import org.gvsig.xmlpull.lib.api.stream.IXmlStreamWriter; |
|
40 |
import org.gvsig.xmlpull.lib.api.stream.IXmlStreamWriterFactory; |
|
41 |
import org.gvsig.xmlpull.lib.api.stream.XmlStreamException; |
|
42 |
import org.gvsig.xmlpull.lib.spi.XmlPullProviderManager; |
|
43 |
|
|
44 |
/** |
|
45 |
* @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a> |
|
46 |
*/ |
|
47 |
public class DefaultXmlPullProviderManager implements XmlPullProviderManager{ |
|
48 |
private List xmlStreamReaderFactories = Collections.synchronizedList(new ArrayList()); |
|
49 |
private List xmlStreamWriterFactories = Collections.synchronizedList(new ArrayList()); |
|
50 |
|
|
51 |
public IXmlStreamReader createStreamReader(String mimeType, InputStream is){ |
|
52 |
Iterator it = xmlStreamReaderFactories.iterator(); |
|
53 |
while (it.hasNext()){ |
|
54 |
IXmlStreamReaderFactory xmlStreamReaderFactory = |
|
55 |
(IXmlStreamReaderFactory)it.next(); |
|
56 |
if (xmlStreamReaderFactory.canParse(mimeType)){ |
|
57 |
try { |
|
58 |
return xmlStreamReaderFactory.createParser(mimeType, is); |
|
59 |
} catch (Exception e) { |
|
60 |
throw new CreateXmlStreamReaderException(mimeType, e); |
|
61 |
} |
|
62 |
} |
|
63 |
} |
|
64 |
throw new IllegalArgumentException("There is not a " + |
|
65 |
"XMLStreamReader for the mimetype " + mimeType); |
|
66 |
|
|
67 |
} |
|
68 |
|
|
69 |
public void registerXMLStreamReaderFactory(IXmlStreamReaderFactory xmlStreamReaderFactory) { |
|
70 |
xmlStreamReaderFactories.add(xmlStreamReaderFactory); |
|
71 |
} |
|
72 |
|
|
73 |
public IXmlStreamWriter createStreamWriter(String mimeType, OutputStream os) |
|
74 |
throws XmlStreamException, IllegalArgumentException { |
|
75 |
Iterator it = xmlStreamWriterFactories.iterator(); |
|
76 |
while (it.hasNext()){ |
|
77 |
IXmlStreamWriterFactory xmlStreamWriterFactory = |
|
78 |
(IXmlStreamWriterFactory)it.next(); |
|
79 |
if (xmlStreamWriterFactory.canWrite(mimeType)){ |
|
80 |
try { |
|
81 |
return xmlStreamWriterFactory.createWriter(mimeType, os); |
|
82 |
} catch (Exception e) { |
|
83 |
throw new CreateXmlStreamWriterException(mimeType, e); |
|
84 |
} |
|
85 |
} |
|
86 |
} |
|
87 |
throw new IllegalArgumentException("There is not a " + |
|
88 |
"XMLStreamWriter for the mimetype " + mimeType); |
|
89 |
} |
|
90 |
|
|
91 |
public void registerXMLStreamWriterFactory( |
|
92 |
IXmlStreamWriterFactory xmlStreamWriterFactory) { |
|
93 |
xmlStreamWriterFactories.add(xmlStreamWriterFactory); |
|
94 |
} |
|
95 |
|
|
96 |
|
|
97 |
} |
|
98 |
|
|
0 | 99 |
org.gvsig.xmlpull/library/tags/org.gvsig.xmlpull-2.0.33/org.gvsig.xmlpull.lib/org.gvsig.xmlpull.lib.impl/src/main/java/org/gvsig/xmlpull/lib/impl/CreateXmlStreamWriterException.java | ||
---|---|---|
1 |
/* gvSIG. Geographic Information System of the Valencian Government |
|
2 |
* |
|
3 |
* Copyright (C) 2007-2008 Infrastructures and Transports Department |
|
4 |
* of the Valencian Government (CIT) |
|
5 |
* |
|
6 |
* This program is free software; you can redistribute it and/or |
|
7 |
* modify it under the terms of the GNU General Public License |
|
8 |
* as published by the Free Software Foundation; either version 2 |
|
9 |
* of the License, or (at your option) any later version. |
|
10 |
* |
|
11 |
* This program is distributed in the hope that it will be useful, |
|
12 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
13 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
14 |
* GNU General Public License for more details. |
|
15 |
* |
|
16 |
* You should have received a copy of the GNU General Public License |
|
17 |
* along with this program; if not, write to the Free Software |
|
18 |
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, |
|
19 |
* MA 02110-1301, USA. |
|
20 |
* |
|
21 |
*/ |
|
22 |
|
|
23 |
/* |
|
24 |
* AUTHORS (In addition to CIT): |
|
25 |
* 2009 {gvSIG} {{Task}} |
|
26 |
*/ |
|
27 |
package org.gvsig.xmlpull.lib.impl; |
|
28 |
|
|
29 |
import org.gvsig.tools.exception.BaseRuntimeException; |
|
30 |
import org.gvsig.xmlpull.lib.api.stream.IXmlStreamReader; |
|
31 |
|
|
32 |
/** |
|
33 |
* Exception thrown when there is an error creating a new {@link IXmlStreamReader}. |
|
34 |
* |
|
35 |
* @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a> |
|
36 |
*/ |
|
37 |
public class CreateXmlStreamWriterException extends |
|
38 |
BaseRuntimeException { |
|
39 |
private static final long serialVersionUID = 6894668637124114583L; |
|
40 |
|
|
41 |
private final static String MESSAGE_FORMAT = "Exception creating the xml stream writer with " + |
|
42 |
"mimeType '%(mimeType)'."; |
|
43 |
private final static String MESSAGE_KEY = "_CreateXMLStreamReaderException"; |
|
44 |
|
|
45 |
public CreateXmlStreamWriterException(String mimeType, Throwable cause){ |
|
46 |
super(MESSAGE_FORMAT, cause, MESSAGE_KEY, serialVersionUID); |
|
47 |
setValue("mimeType", mimeType); |
|
48 |
} |
|
49 |
} |
|
0 | 50 |
org.gvsig.xmlpull/library/tags/org.gvsig.xmlpull-2.0.33/org.gvsig.xmlpull.lib/org.gvsig.xmlpull.lib.impl/src/main/java/org/gvsig/xmlpull/lib/impl/DefaultXmlPullManager.java | ||
---|---|---|
1 |
/* gvSIG. Geographic Information System of the Valencian Government |
|
2 |
* |
|
3 |
* Copyright (C) 2007-2008 Infrastructures and Transports Department |
|
4 |
* of the Valencian Government (CIT) |
|
5 |
* |
|
6 |
* This program is free software; you can redistribute it and/or |
|
7 |
* modify it under the terms of the GNU General Public License |
|
8 |
* as published by the Free Software Foundation; either version 2 |
|
9 |
* of the License, or (at your option) any later version. |
|
10 |
* |
|
11 |
* This program is distributed in the hope that it will be useful, |
|
12 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
13 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
14 |
* GNU General Public License for more details. |
|
15 |
* |
|
16 |
* You should have received a copy of the GNU General Public License |
|
17 |
* along with this program; if not, write to the Free Software |
|
18 |
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, |
|
19 |
* MA 02110-1301, USA. |
|
20 |
* |
|
21 |
*/ |
|
22 |
|
|
23 |
/* |
|
24 |
* AUTHORS (In addition to CIT): |
|
25 |
* 2010 {Iver T.I.} {Task} |
|
26 |
*/ |
|
27 |
|
|
28 |
package org.gvsig.xmlpull.lib.impl; |
|
29 |
|
|
30 |
import java.io.InputStream; |
|
31 |
import java.io.OutputStream; |
|
32 |
|
|
33 |
import org.gvsig.xmlpull.lib.api.XmlPullManager; |
|
34 |
import org.gvsig.xmlpull.lib.api.stream.IXmlStreamReader; |
|
35 |
import org.gvsig.xmlpull.lib.api.stream.IXmlStreamWriter; |
|
36 |
import org.gvsig.xmlpull.lib.api.stream.XmlStreamException; |
|
37 |
import org.gvsig.xmlpull.lib.spi.XmlPullProviderLocator; |
|
38 |
import org.gvsig.xmlpull.lib.spi.XmlPullProviderManager; |
|
39 |
|
|
40 |
/** |
|
41 |
* @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a> |
|
42 |
*/ |
|
43 |
public class DefaultXmlPullManager implements XmlPullManager{ |
|
44 |
private XmlPullProviderManager xmlPullProviderManager = null; |
|
45 |
|
|
46 |
private XmlPullProviderManager getXmlPullProviderManager() { |
|
47 |
if (xmlPullProviderManager == null){ |
|
48 |
xmlPullProviderManager = XmlPullProviderLocator.getXMLProviderManager(); |
|
49 |
} |
|
50 |
return xmlPullProviderManager; |
|
51 |
} |
|
52 |
|
|
53 |
public IXmlStreamReader createStreamReader(String mimeType, InputStream is) |
|
54 |
throws XmlStreamException, IllegalArgumentException { |
|
55 |
return getXmlPullProviderManager().createStreamReader(mimeType, is); |
|
56 |
} |
|
57 |
|
|
58 |
public IXmlStreamWriter createStreamWriter(String mimeType, OutputStream os) |
|
59 |
throws XmlStreamException, IllegalArgumentException { |
|
60 |
return getXmlPullProviderManager().createStreamWriter(mimeType, os); |
|
61 |
} |
|
62 |
|
|
63 |
} |
|
64 |
|
|
0 | 65 |
org.gvsig.xmlpull/library/tags/org.gvsig.xmlpull-2.0.33/org.gvsig.xmlpull.lib/org.gvsig.xmlpull.lib.impl/src/main/resources/META-INF/services/org.gvsig.tools.library.Library | ||
---|---|---|
1 |
org.gvsig.xmlpull.lib.impl.DefaultXmlPullLibrary |
|
2 |
|
org.gvsig.xmlpull/library/tags/org.gvsig.xmlpull-2.0.33/org.gvsig.xmlpull.lib/org.gvsig.xmlpull.lib.impl/pom.xml | ||
---|---|---|
1 |
<?xml version="1.0" encoding="ISO-8859-1"?> |
|
2 |
|
|
3 |
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> |
|
4 |
<modelVersion>4.0.0</modelVersion> |
|
5 |
<artifactId>org.gvsig.xmlpull.lib.impl</artifactId> |
|
6 |
<packaging>jar</packaging> |
|
7 |
<name>org.gvsig.xmlpull.lib.impl</name> |
|
8 |
<description>Default XML Pull library Implementation</description> |
|
9 |
<parent> |
|
10 |
<groupId>org.gvsig</groupId> |
|
11 |
<artifactId>org.gvsig.xmlpull.lib</artifactId> |
|
12 |
<version>2.0.33</version> |
|
13 |
</parent> |
|
14 |
<dependencies> |
|
15 |
|
|
16 |
<dependency> |
|
17 |
<groupId>org.gvsig</groupId> |
|
18 |
<artifactId>org.gvsig.tools.lib</artifactId> |
|
19 |
</dependency> |
|
20 |
<dependency> |
|
21 |
<groupId>org.gvsig</groupId> |
|
22 |
<artifactId>org.gvsig.tools.lib</artifactId> |
|
23 |
<type>test-jar</type> |
|
24 |
</dependency> |
|
25 |
|
|
26 |
<dependency> |
|
27 |
<groupId>org.gvsig</groupId> |
|
28 |
<artifactId>org.gvsig.xmlpull.lib.api</artifactId> |
|
29 |
</dependency> |
|
30 |
<dependency> |
|
31 |
<groupId>org.gvsig</groupId> |
|
32 |
<artifactId>org.gvsig.xmlpull.lib.spi</artifactId> |
|
33 |
</dependency> |
|
34 |
</dependencies> |
|
35 |
<build> |
|
36 |
<plugins> |
|
37 |
<plugin> |
|
38 |
<groupId>org.apache.maven.plugins</groupId> |
|
39 |
<artifactId>maven-compiler-plugin</artifactId> |
|
40 |
<configuration> |
|
41 |
<source>1.4</source> |
|
42 |
<target>1.5</target> |
|
43 |
</configuration> |
|
44 |
</plugin> |
|
45 |
</plugins> |
|
46 |
</build> |
|
47 |
<profiles> |
|
48 |
<profile> |
|
49 |
<id>cdc</id> |
|
50 |
<build> |
|
51 |
<plugins> |
|
52 |
<plugin> |
|
53 |
<groupId>org.apache.maven.plugins</groupId> |
|
54 |
<artifactId>maven-compiler-plugin</artifactId> |
|
55 |
<configuration> |
|
56 |
<source>1.4</source> |
|
57 |
<target>1.4</target> |
|
58 |
</configuration> |
|
59 |
</plugin> |
|
60 |
</plugins> |
|
61 |
</build> |
|
62 |
</profile> |
|
63 |
</profiles> |
|
64 |
</project> |
|
0 | 65 |
org.gvsig.xmlpull/library/tags/org.gvsig.xmlpull-2.0.33/org.gvsig.xmlpull.lib/pom.xml | ||
---|---|---|
1 |
<?xml version="1.0" encoding="ISO-8859-1"?> |
|
2 |
|
|
3 |
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> |
|
4 |
<modelVersion>4.0.0</modelVersion> |
|
5 |
<artifactId>org.gvsig.xmlpull.lib</artifactId> |
|
6 |
<packaging>pom</packaging> |
|
7 |
<name>org.gvsig.xmlpull.lib</name> |
|
8 |
<description>XML Pull library</description> |
|
9 |
<parent> |
|
10 |
<groupId>org.gvsig</groupId> |
|
11 |
<artifactId>org.gvsig.xmlpull</artifactId> |
|
12 |
<version>2.0.33</version> |
|
13 |
</parent> |
|
14 |
<modules> |
|
15 |
<module>org.gvsig.xmlpull.lib.api</module> |
|
16 |
<module>org.gvsig.xmlpull.lib.spi</module> |
|
17 |
<module>org.gvsig.xmlpull.lib.impl</module> |
|
18 |
</modules> |
|
19 |
</project> |
|
0 | 20 |
org.gvsig.xmlpull/library/tags/org.gvsig.xmlpull-2.0.33/org.gvsig.xmlpull.lib/org.gvsig.xmlpull.lib.api/src/main/java/org/gvsig/xmlpull/lib/api/stream/IXmlStreamReaderFactory.java | ||
---|---|---|
1 |
package org.gvsig.xmlpull.lib.api.stream; |
|
2 |
|
|
3 |
import java.io.InputStream; |
|
4 |
|
|
5 |
/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana |
|
6 |
* |
|
7 |
* Copyright (C) 2004 IVER T.I. and Generalitat Valenciana. |
|
8 |
* |
|
9 |
* This program is free software; you can redistribute it and/or |
|
10 |
* modify it under the terms of the GNU General Public License |
|
11 |
* as published by the Free Software Foundation; either version 2 |
|
12 |
* of the License, or (at your option) any later version. |
|
13 |
* |
|
14 |
* This program is distributed in the hope that it will be useful, |
|
15 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
16 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
17 |
* GNU General Public License for more details. |
|
18 |
* |
|
19 |
* You should have received a copy of the GNU General Public License |
|
20 |
* along with this program; if not, write to the Free Software |
|
21 |
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,USA. |
|
22 |
* |
|
23 |
* For more information, contact: |
|
24 |
* |
|
25 |
* Generalitat Valenciana |
|
26 |
* Conselleria d'Infraestructures i Transport |
|
27 |
* Av. Blasco Ib??ez, 50 |
|
28 |
* 46010 VALENCIA |
|
29 |
* SPAIN |
|
30 |
* |
|
31 |
* +34 963862235 |
|
32 |
* gvsig@gva.es |
|
33 |
* www.gvsig.gva.es |
|
34 |
* |
|
35 |
* or |
|
36 |
* |
|
37 |
* IVER T.I. S.A |
|
38 |
* Salamanca 50 |
|
39 |
* 46005 Valencia |
|
40 |
* Spain |
|
41 |
* |
|
42 |
* +34 963163400 |
|
43 |
* dac@iver.es |
|
44 |
*/ |
|
45 |
|
|
46 |
/** |
|
47 |
* |
|
48 |
*/ |
|
49 |
public interface IXmlStreamReaderFactory { |
|
50 |
|
|
51 |
boolean canParse(String mimeType); |
|
52 |
|
|
53 |
IXmlStreamReader createParser(String mimeType, InputStream in) throws XmlStreamException, |
|
54 |
IllegalArgumentException; |
|
55 |
} |
|
0 | 56 |
org.gvsig.xmlpull/library/tags/org.gvsig.xmlpull-2.0.33/org.gvsig.xmlpull.lib/org.gvsig.xmlpull.lib.api/src/main/java/org/gvsig/xmlpull/lib/api/stream/IXmlStreamWriter.java | ||
---|---|---|
1 |
/* gvSIG. Sistem a de Informaci?n Geogr?fica de la Generalitat Valenciana |
|
2 |
* |
|
3 |
* Copyright (C) 2007 Generalitat Valenciana. |
|
4 |
* |
|
5 |
* This program is free software; you can redistribute it and/or |
|
6 |
* modify it under the terms of the GNU General Public License |
|
7 |
* as published by the Free Software Foundation; either version 2 |
|
8 |
* of the License, or (at your option) any later version. |
|
9 |
* |
|
10 |
* This program is distributed in the hope that it will be useful, |
|
11 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
12 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
13 |
* GNU General Public License for more details. |
|
14 |
* |
|
15 |
* You should have received a copy of the GNU General Public License |
|
16 |
* along with this program; if not, write to the Free Software |
|
17 |
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,USA. |
|
18 |
* |
|
19 |
* For more information, contact: |
|
20 |
* |
|
21 |
* Generalitat Valenciana |
|
22 |
* Conselleria d'Infraestructures i Transport |
|
23 |
* Av. Blasco Ib??ez, 50 |
|
24 |
* 46010 VALENCIA |
|
25 |
* SPAIN |
|
26 |
* |
|
27 |
* +34 9638 62 495 |
|
28 |
* gvsig@gva.es |
|
29 |
* www.gvsig.gva.es |
|
30 |
*/ |
|
31 |
package org.gvsig.xmlpull.lib.api.stream; |
|
32 |
|
|
33 |
import java.io.IOException; |
|
34 |
|
|
35 |
/** |
|
36 |
* IXmlStreamWriter defines an "XML push" like streaming API for writing XML documents encoded as |
|
37 |
* per the OGC Binary XML Best Practices document. |
|
38 |
* <p> |
|
39 |
* This interface does not defines setter methods to control encoding behavior such as byte order to |
|
40 |
* use or character encoding. A IXmlStreamWriter instance is meant to be already configured with the |
|
41 |
* desired encoding options when returned from the {@link BxmlOutputFactory}. |
|
42 |
* </p> |
|
43 |
* <p> |
|
44 |
* Sample usage: |
|
45 |
* |
|
46 |
* <pre> |
|
47 |
* <code> |
|
48 |
* BxmlOutputFactory factory = BxmlFactoryFinder.newOutputFactory(); |
|
49 |
* IXmlStreamWriter writer = factory.createSerializer(inputStream); |
|
50 |
* |
|
51 |
* writer.setSchemaLocation("http://www.example.com", "http://www.example.com/schema.xsd"); |
|
52 |
* |
|
53 |
* writer.writeStartDocument(); |
|
54 |
* |
|
55 |
* writer.setPrefix("ex", "http://www.example.com") |
|
56 |
* writer.setDefaultNamespace("http://www.anotherexample.com"); |
|
57 |
* |
|
58 |
* writer.writeStartElement("", "root"); |
|
59 |
* |
|
60 |
* writer.writeStartElement("http://www.example.com", "child"); |
|
61 |
* |
|
62 |
* //child attributes list... |
|
63 |
* writer.writeStartAttribute("http://www.example.com", "att"); |
|
64 |
* writer.writeValue("attValue"); |
|
65 |
* writer.writeStartAttribute("http://www.example.com", "emptyAtt"); |
|
66 |
* writer.writeEndAttributes(); |
|
67 |
* |
|
68 |
* //child value as a purely streamed int array |
|
69 |
* writer.startArray(EventType.VALUE_INT, 10); |
|
70 |
* for(int i = 0; i < 10; i++){ |
|
71 |
* writer.writeValue(i); |
|
72 |
* } |
|
73 |
* writer.endArray(); |
|
74 |
* |
|
75 |
* writer.writeComment("interleaved value type follow"); |
|
76 |
* |
|
77 |
* writer.writeValue("10 11 12 13"); |
|
78 |
* |
|
79 |
* writer.writeEndElement(); // child |
|
80 |
* writer.writeEndElement(); // root |
|
81 |
* writer.writeEndDocument(); |
|
82 |
* </code> |
|
83 |
* </pre> |
|
84 |
* |
|
85 |
* </p> |
|
86 |
* |
|
87 |
* @author Gabriel Roldan (TOPP) |
|
88 |
* @version $Id: IXmlStreamWriter.java 21945 2008-06-30 14:04:53Z jpiera $ |
|
89 |
* @since 1.0 |
|
90 |
*/ |
|
91 |
public interface IXmlStreamWriter { |
|
92 |
|
|
93 |
/** |
|
94 |
* Returns a safe copy of the encoding options this writer is settled up with. |
|
95 |
* <p> |
|
96 |
* Modifications to the returned object state does not affect this writer behaviour. |
|
97 |
* </p> |
|
98 |
* |
|
99 |
* @return an object representing the set of encoding options this writer operates with |
|
100 |
*/ |
|
101 |
//public EncodingOptions getEncodingOptions(); |
|
102 |
|
|
103 |
/** |
|
104 |
* Returns the event corresponding to the last write call. |
|
105 |
* <p> |
|
106 |
* For example, if the last write call was |
|
107 |
* {@link #writeStartElement(String, String) writeStartElement} it shall return |
|
108 |
* {@link EventType#START_ELEMENT START_ELEMENT}, if it was |
|
109 |
* {@link #writeStartAttribute(String, String) writeStartAttribute}, |
|
110 |
* {@link EventType#ATTRIBUTE ATTRIBUTE}, etc. |
|
111 |
* </p> |
|
112 |
* |
|
113 |
* @post {$return != null} |
|
114 |
* @return {@link EventType#NONE} if writing has not yet started (ie, writeStartDocument has not |
|
115 |
* been called), the event for the last write operation otherwise. |
|
116 |
*/ |
|
117 |
public EventType getLastEvent(); |
|
118 |
|
|
119 |
/** |
|
120 |
* @return {@code null} if no tag event has been written yet, START_ELEMENT or END_ELEMENT |
|
121 |
* otherwise, depending on which of them was lately called |
|
122 |
*/ |
|
123 |
public EventType getLastTagEvent(); |
|
124 |
|
|
125 |
/** |
|
126 |
* @post {$return >= 0} |
|
127 |
* @return how deep is the current element tree |
|
128 |
*/ |
|
129 |
public int getTagDeep(); |
|
130 |
|
|
131 |
/** |
|
132 |
* Closes this stream writer and releases any system resources associated with it, including the |
|
133 |
* underlying output stream or any other output source it may be operating upon. |
|
134 |
* <p> |
|
135 |
* A call to this method implies a flush of any possible buffered wtrite before closing the |
|
136 |
* stream. |
|
137 |
* </p> |
|
138 |
* <p> |
|
139 |
* The first call to this method closes and releases resources. Subsequent calls shall take no |
|
140 |
* effect and return quitely. After the first call to this method any non query method (defined |
|
141 |
* as metadata retrieval methods in the class' javadoc) shall fail with an io exception. |
|
142 |
* </p> |
|
143 |
* |
|
144 |
* @throws IOException if an I/O error occurs. |
|
145 |
*/ |
|
146 |
public void close() throws IOException; |
|
147 |
|
|
148 |
/** |
|
149 |
* Returns whether this stream writer and its underlying output source are open and able to |
|
150 |
* receive more write calls. |
|
151 |
* <p> |
|
152 |
* A {@code IXmlStreamWriter} should be open since its creation until {@link #close()} is |
|
153 |
* explicitly called by client code. |
|
154 |
* </p> |
|
155 |
* |
|
156 |
* @return {@code true} if this stream is still open, {@code false} otherwise |
|
157 |
*/ |
|
158 |
public boolean isOpen(); |
|
159 |
|
|
160 |
/** |
|
161 |
* Write any cached data to the underlying output mechanism. |
|
162 |
* |
|
163 |
* @throws IOException |
|
164 |
*/ |
|
165 |
public void flush() throws IOException; |
|
166 |
|
|
167 |
/** |
|
168 |
* @pre {getLastEvent() == NONE} |
|
169 |
* @pre {namespaceUri != null AND schemaLocationUri != null} |
|
170 |
* @pre {namespaceUri != ""} |
|
171 |
* @param namespaceUri |
|
172 |
* @param schemaLocationUri |
|
173 |
*/ |
|
174 |
public void setSchemaLocation(String namespaceUri, String schemaLocationUri); |
|
175 |
|
|
176 |
/** |
|
177 |
* Initiates the encoding of an XML formatted document in the BXML encoding. |
|
178 |
* <p> |
|
179 |
* This should be the first non query method to call after a stream writer is created. The |
|
180 |
* implementation will use the call to this method to write down the document header and xml |
|
181 |
* declaration. |
|
182 |
* </p> |
|
183 |
* |
|
184 |
* @pre {getLastEvent() == NONE} |
|
185 |
* @post {getLastEvent() == START_DOCUMENT} |
|
186 |
* @throws IOException |
|
187 |
*/ |
|
188 |
public void writeStartDocument() throws IOException; |
|
189 |
|
|
190 |
/** |
|
191 |
* Finishes up encoding a BXML document. |
|
192 |
* <p> |
|
193 |
* Implementations shall use this method to write down the document's trailer token. |
|
194 |
* </p> |
|
195 |
* |
|
196 |
* @pre {getTagDeep() == 0} |
|
197 |
* @post {getLastEvent() == END_DOCUMENT} |
|
198 |
* @throws IOException |
|
199 |
*/ |
|
200 |
public void writeEndDocument() throws IOException; |
|
201 |
|
|
202 |
/** |
|
203 |
* @pre {namespaceUri != null} |
|
204 |
* @pre {localName != null} |
|
205 |
* @post {getLastEvent() == START_ELEMENT} |
|
206 |
* @param namespaceUri the namespace uri for the element |
|
207 |
* @param localName the elements non qualified (local) name |
|
208 |
* @throws IOException |
|
209 |
*/ |
|
210 |
public void writeStartElement(final String namespaceUri, final String localName) |
|
211 |
throws IOException; |
|
212 |
|
|
213 |
/** |
|
214 |
* @pre {qname != null} |
|
215 |
* @post {getLastEvent() == START_ELEMENT} |
|
216 |
* @param qname qualified element name. Only namespace and localName are relevant. Prefix, if |
|
217 |
* present, is ignored. The currently mapped prefix for the namespace will be used in |
|
218 |
* any case. |
|
219 |
* @throws IOException |
|
220 |
* @see #setPrefix(String, String) |
|
221 |
*/ |
|
222 |
public void writeStartElement(final IQName qname) throws IOException; |
|
223 |
|
|
224 |
/** |
|
225 |
* @pre {getTagDeep() > 0} |
|
226 |
* @pre { ( getLastEvent().isValue() AND getWrittenValueCount() == getValueLength() ) || |
|
227 |
* getLastEvent() IN ( START_ELEMENT, END_ELEMENT, ATTRIBUTES_END, COMMENT} |
|
228 |
* @post {getLastEvent() == END_ELEMENT} |
|
229 |
* @throws IOException |
|
230 |
*/ |
|
231 |
public void writeEndElement() throws IOException; |
|
232 |
|
|
233 |
/** |
|
234 |
* Starts writting an xml attribute. |
|
235 |
* <p> |
|
236 |
* Writting an attribute and its value is split in two parts. This method only stand for the |
|
237 |
* attribute declaration. Writting an attribute value is made after calling this method and is |
|
238 |
* optional. The attribute value can be done with any of the {@code writeValue} methods, even |
|
239 |
* using various {@code writeValue} calls for the same attribute. |
|
240 |
* </p> |
|
241 |
* <p> |
|
242 |
* After the last element attribute has been written, {@link #writeEndAttributes()} shall be |
|
243 |
* called to indicate the end of the attribute list. |
|
244 |
* </p> |
|
245 |
* Sample usage: |
|
246 |
* |
|
247 |
* <pre> |
|
248 |
* <code> |
|
249 |
* <b>writer.startAttribute("", "att1");</b> |
|
250 |
* writer.writeValue("value1"); |
|
251 |
* writer.writeValue(1); |
|
252 |
* writer.writeValue(2); |
|
253 |
* writer.writeValue(3); |
|
254 |
* <b>writer.startAttribute("", "att2");</b> |
|
255 |
* writer.writeValue(1.0L); |
|
256 |
* ... |
|
257 |
* writer.writeEndAttributes(); |
|
258 |
* </code> |
|
259 |
* </pre> |
|
260 |
* |
|
261 |
* @pre {getLastEvent() IN (START_ELEMENT, ATTRIBUTE) } |
|
262 |
* @pre {namespaceUri != null} |
|
263 |
* @pre {localName != null} |
|
264 |
* @post {getLastEvent() == ATTRIBUTE} |
|
265 |
* @param namespaceUri not null |
|
266 |
* @param localName not null |
|
267 |
* @throws IOException |
|
268 |
* @see #writeEndAttributes() |
|
269 |
*/ |
|
270 |
public void writeStartAttribute(final String namespaceUri, final String localName) |
|
271 |
throws IOException; |
|
272 |
|
|
273 |
/** |
|
274 |
* Starts writing an xml attribute for the given qualified name. |
|
275 |
* |
|
276 |
* @pre {qname != null} |
|
277 |
* @param qname a QName where to get the namespace uri and local name for the attribute |
|
278 |
* @throws IOException |
|
279 |
* @see #writeStartAttribute(String, String) |
|
280 |
*/ |
|
281 |
public void writeStartAttribute(final IQName qname) throws IOException; |
|
282 |
|
|
283 |
/** |
|
284 |
* Indicates there are no more element attributes to encode for the current element. |
|
285 |
* <p> |
|
286 |
* This method is useful for the encoder to recognize (and write down the appropriate tokens) |
|
287 |
* the following potential call to some writeValue method corresponds to the element's contents |
|
288 |
* and not to the current attribute value. |
|
289 |
* </p> |
|
290 |
* Sample usage: |
|
291 |
* |
|
292 |
* <pre> |
|
293 |
* <code> |
|
294 |
* writer.startElement("", "element"); |
|
295 |
* writer.startAttribute("", "att1"); |
|
296 |
* writer.writeValue("value1"); |
|
297 |
* writer.startAttribute("", "att2"); |
|
298 |
* writer.writeValue(1.0L); |
|
299 |
* ... |
|
300 |
* <b>writer.writeEndAttributes();</b> |
|
301 |
* writer.value("element value"); |
|
302 |
* ... |
|
303 |
* </code> |
|
304 |
* </pre> |
|
305 |
* |
|
306 |
* @pre {getLastTagEvent() == START_ELEMENT} |
|
307 |
* @post {getLastEvent() == ATTRIBUTES_END} |
|
308 |
* @throws IOException |
|
309 |
*/ |
|
310 |
public void writeEndAttributes() throws IOException; |
|
311 |
|
|
312 |
/** |
|
313 |
* @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE, |
|
314 |
* COMMENT )} |
|
315 |
* @post {getLastEvent() == VALUE_STRING} |
|
316 |
* @post {getValueLength() == 1} |
|
317 |
* @post {getWrittenValueCount() == 1} |
|
318 |
* @param value |
|
319 |
* @throws IOException |
|
320 |
*/ |
|
321 |
public void writeValue(final String value) throws IOException; |
|
322 |
|
|
323 |
/** |
|
324 |
* @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE, |
|
325 |
* COMMENT )} |
|
326 |
* @post {getLastEvent() == VALUE_STRING} |
|
327 |
* @param chars |
|
328 |
* @param offset |
|
329 |
* @param length |
|
330 |
* @throws IOException |
|
331 |
*/ |
|
332 |
public void writeValue(final char[] chars, final int offset, final int length) |
|
333 |
throws IOException; |
|
334 |
|
|
335 |
/** |
|
336 |
* @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE, |
|
337 |
* COMMENT )} |
|
338 |
* @post {getLastEvent() == VALUE_INT} |
|
339 |
* @param value |
|
340 |
* @throws IOException |
|
341 |
*/ |
|
342 |
public void writeValue(final int value) throws IOException; |
|
343 |
|
|
344 |
/** |
|
345 |
* @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE, |
|
346 |
* COMMENT )} |
|
347 |
* @post {getLastEvent() == VALUE_LONG} |
|
348 |
* @param value |
|
349 |
* @throws IOException |
|
350 |
*/ |
|
351 |
public void writeValue(final long value) throws IOException; |
|
352 |
|
|
353 |
/** |
|
354 |
* @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE, |
|
355 |
* COMMENT )} |
|
356 |
* @post {getLastEvent() == VALUE_FLOAT} |
|
357 |
* @param value |
|
358 |
* @throws IOException |
|
359 |
*/ |
|
360 |
public void writeValue(final float value) throws IOException; |
|
361 |
|
|
362 |
/** |
|
363 |
* @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE, |
|
364 |
* COMMENT )} |
|
365 |
* @post {getLastEvent() == VALUE_DOUBLE} |
|
366 |
* @param value |
|
367 |
* @throws IOException |
|
368 |
*/ |
|
369 |
public void writeValue(final double value) throws IOException; |
|
370 |
|
|
371 |
/** |
|
372 |
* @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE, |
|
373 |
* COMMENT )} |
|
374 |
* @post {getLastEvent() == VALUE_BOOL} |
|
375 |
* @param value |
|
376 |
* @throws IOException |
|
377 |
*/ |
|
378 |
public void writeValue(final boolean value) throws IOException; |
|
379 |
|
|
380 |
/** |
|
381 |
* @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE, |
|
382 |
* COMMENT )} |
|
383 |
* @post {getLastEvent() == VALUE_BOOL} |
|
384 |
* @param value |
|
385 |
* @param offset |
|
386 |
* @param length |
|
387 |
* @throws IOException |
|
388 |
*/ |
|
389 |
public void writeValue(final boolean[] value, final int offset, final int length) |
|
390 |
throws IOException; |
|
391 |
|
|
392 |
/** |
|
393 |
* @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE, |
|
394 |
* COMMENT )} |
|
395 |
* @post {getLastEvent() == VALUE_INT} |
|
396 |
* @param value |
|
397 |
* @param offset |
|
398 |
* @param length |
|
399 |
* @throws IOException |
|
400 |
*/ |
|
401 |
public void writeValue(final int[] value, final int offset, final int length) |
|
402 |
throws IOException; |
|
403 |
|
|
404 |
/** |
|
405 |
* @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE, |
|
406 |
* COMMENT )} |
|
407 |
* @post {getLastEvent() == VALUE_LONG} |
|
408 |
* @param value |
|
409 |
* @param offset |
|
410 |
* @param length |
|
411 |
* @throws IOException |
|
412 |
*/ |
|
413 |
public void writeValue(final long[] value, final int offset, final int length) |
|
414 |
throws IOException; |
|
415 |
|
|
416 |
/** |
|
417 |
* @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE, |
|
418 |
* COMMENT )} |
|
419 |
* @post {getLastEvent() == VALUE_FLOAT} |
|
420 |
* @param value |
|
421 |
* @param offset |
|
422 |
* @param length |
|
423 |
* @throws IOException |
|
424 |
*/ |
|
425 |
public void writeValue(final float[] value, final int offset, final int length) |
|
426 |
throws IOException; |
|
427 |
|
|
428 |
/** |
|
429 |
* Writes a value section defined by the |
|
430 |
* |
|
431 |
* @pre {getLastEvent() IN ( START_ELEMENT START_ELEMENT, ATTRIBUTE ATTRIBUTE )} |
|
432 |
* @post {getLastEvent() == VALUE_DOUBLE} |
|
433 |
* @param value |
|
434 |
* @param offset |
|
435 |
* @param length |
|
436 |
* @throws IOException |
|
437 |
*/ |
|
438 |
public void writeValue(final double[] value, int offset, int length) throws IOException; |
|
439 |
|
|
440 |
/** |
|
441 |
* Writes a comments block |
|
442 |
* <p> |
|
443 |
* The provided {@code commentContent} is the coalesced value of the equivalent XML comment |
|
444 |
* block (enclosed between {@code <!--} and {@code -->} tags. |
|
445 |
* </p> |
|
446 |
* |
|
447 |
* @post {getLastEvent() == COMMENT} |
|
448 |
* @param commentContent the coallesced value of the comment section |
|
449 |
* @throws IOException |
|
450 |
*/ |
|
451 |
public void writeComment(String commentContent) throws IOException; |
|
452 |
|
|
453 |
/** |
|
454 |
* @pre {valueType != null} |
|
455 |
* @pre {valueType.isValue() == true} |
|
456 |
* @pre {valueType != VALUE_STRING} |
|
457 |
* @pre {arrayLength >= 0} |
|
458 |
* @post {getLastEvent() == valueType} |
|
459 |
* @post {getWrittenValueCount() == 0} |
|
460 |
* @post {getValueLength() == arrayLength} |
|
461 |
* @param valueType |
|
462 |
* @param arrayLength |
|
463 |
* @throws IOException |
|
464 |
*/ |
|
465 |
public void startArray(EventType valueType, int arrayLength) throws IOException; |
|
466 |
|
|
467 |
/** |
|
468 |
* Needs to be called when done with startArray |
|
469 |
* |
|
470 |
* @pre {getWrittenValueCount() == getValueLength()} |
|
471 |
* @throws IOException |
|
472 |
*/ |
|
473 |
public void endArray() throws IOException; |
|
474 |
|
|
475 |
/** |
|
476 |
* Binds a URI to the default namespace for the current context. |
|
477 |
* <p> |
|
478 |
* This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this |
|
479 |
* method is called before a START_ELEMENT has been written the uri is bound in the root scope. |
|
480 |
* </p> |
|
481 |
* |
|
482 |
* @pre {getLastEvent() == NONE || getLastEvent() == START_ELEMENT} |
|
483 |
* @param defaultNamespaceUri the uri to bind to the default namespace, may be {@code null} |
|
484 |
* @throws XmlStreamException |
|
485 |
*/ |
|
486 |
public void setDefaultNamespace(String defaultNamespaceUri) throws XmlStreamException; |
|
487 |
|
|
488 |
/** |
|
489 |
* Sets the prefix the uri is bound to, for the current context. |
|
490 |
* <p> |
|
491 |
* This prefix is bound in the scope of the current START_ELEMENT / END_ELEMENT pair (current |
|
492 |
* context). If this method is called before a START_ELEMENT has been written the prefix is |
|
493 |
* bound in the root scope. |
|
494 |
* </p> |
|
495 |
* |
|
496 |
* @pre {getLastEvent() == NONE || getLastEvent() == START_ELEMENT} |
|
497 |
* @param prefix |
|
498 |
* @param namespaceUri |
|
499 |
* @throws XmlStreamException |
|
500 |
*/ |
|
501 |
public void setPrefix(final String prefix, final String namespaceUri) throws XmlStreamException; |
|
502 |
|
|
503 |
/** |
|
504 |
* @pre {getLastEvent().isValue() == true} |
|
505 |
* @post {$return >= 0} |
|
506 |
* @return the length of the current value being written. |
|
507 |
*/ |
|
508 |
public long getValueLength(); |
|
509 |
|
|
510 |
/** |
|
511 |
* @pre {getLastEvent().isValue() == true} |
|
512 |
* @post {$return >= 0} |
|
513 |
* @post {$return <= getValueLength()} |
|
514 |
* @return how many elements has already being written for the current value |
|
515 |
*/ |
|
516 |
public long getWrittenValueCount(); |
|
517 |
|
|
518 |
} |
|
0 | 519 |
org.gvsig.xmlpull/library/tags/org.gvsig.xmlpull-2.0.33/org.gvsig.xmlpull.lib/org.gvsig.xmlpull.lib.api/src/main/java/org/gvsig/xmlpull/lib/api/stream/EventType.java | ||
---|---|---|
1 |
/* gvSIG. Sistem a de Informaci?n Geogr?fica de la Generalitat Valenciana |
|
2 |
* |
|
3 |
* Copyright (C) 2007 Generalitat Valenciana. |
|
4 |
* |
|
5 |
* This program is free software; you can redistribute it and/or |
|
6 |
* modify it under the terms of the GNU General Public License |
|
7 |
* as published by the Free Software Foundation; either version 2 |
|
8 |
* of the License, or (at your option) any later version. |
|
9 |
* |
|
10 |
* This program is distributed in the hope that it will be useful, |
|
11 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
12 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
13 |
* GNU General Public License for more details. |
|
14 |
* |
|
15 |
* You should have received a copy of the GNU General Public License |
|
16 |
* along with this program; if not, write to the Free Software |
|
17 |
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,USA. |
|
18 |
* |
|
19 |
* For more information, contact: |
|
20 |
* |
|
21 |
* Generalitat Valenciana |
|
22 |
* Conselleria d'Infraestructures i Transport |
|
23 |
* Av. Blasco Ib??ez, 50 |
|
24 |
* 46010 VALENCIA |
|
25 |
* SPAIN |
|
26 |
* |
|
27 |
* +34 9638 62 495 |
|
28 |
* gvsig@gva.es |
|
29 |
* www.gvsig.gva.es |
|
30 |
*/ |
|
31 |
package org.gvsig.xmlpull.lib.api.stream; |
|
32 |
|
|
33 |
|
|
34 |
/** |
|
35 |
* The EventType enum defines the possible parse events a {@link IXmlStreamReader} may return during |
|
36 |
* each call to {@code next()}. |
|
37 |
* <p> |
|
38 |
* These are high level events and may not map one to one to the low level Binary XML format tokens. |
|
39 |
* This is so to better reflect the problem domain for this high level API, letting the low level |
|
40 |
* treatment of specific bxml tokens to the implementation criteria. |
|
41 |
* </p> |
|
42 |
* <p> |
|
43 |
* In general lines, it could be said that the following EventType to TokenType mappings are |
|
44 |
* defined: <table> |
|
45 |
* <tr> |
|
46 |
* <th>EventType</th> |
|
47 |
* <th>TokenType</th> |
|
48 |
* </tr> |
|
49 |
* <tr> |
|
50 |
* <td>NONE</td> |
|
51 |
* <td>Header</td> |
|
52 |
* </tr> |
|
53 |
* <tr> |
|
54 |
* <td>START_DOCUMENT</td> |
|
55 |
* <td>XmlDeclaration, if present, forced otherwise in order to always return a START_DOCUMENT |
|
56 |
* event</td> |
|
57 |
* </tr> |
|
58 |
* <tr> |
|
59 |
* <td>END_DOCUMENT</td> |
|
60 |
* <td>Trailer</td> |
|
61 |
* </tr> |
|
62 |
* <tr> |
|
63 |
* <td>START_ELEMENT</td> |
|
64 |
* <td>EmptyElement, EmptyAttrElement, ContentElement, ContentAttrElement</td> |
|
65 |
* </tr> |
|
66 |
* <tr> |
|
67 |
* <td>END_ELEMENT</td> |
|
68 |
* <td>ElementEnd, or forced when EmptyElement or EmptyAttrElement</td> |
|
69 |
* </tr> |
|
70 |
* <tr> |
|
71 |
* <td>ATTRIBUTE</td> |
|
72 |
* <td>AttributeStart, only used for writing</td> |
|
73 |
* </tr> |
|
74 |
* <tr> |
|
75 |
* <td>ATTRIBUTES_END</td> |
|
76 |
* <td>AttributeListEnd, only used for writing</td> |
|
77 |
* </tr> |
|
78 |
* <tr> |
|
79 |
* <td>COMMENT</td> |
|
80 |
* <td>Comment</td> |
|
81 |
* </tr> |
|
82 |
* <tr> |
|
83 |
* <td>SPACE</td> |
|
84 |
* <td>WhiteSpace</td> |
|
85 |
* </tr> |
|
86 |
* <tr> |
|
87 |
* <td>VALUE_STRING, VALUE_BOOL, VALUE_BYTE, VALUE_INT, VALUE_LONG, VALUE_FLOAT, VALUE_DOUBLE</td> |
|
88 |
* <td>CharContent token, followed by the specific value type</td> |
|
89 |
* </tr> |
|
90 |
* </table> |
|
91 |
* </p> |
|
92 |
* |
|
93 |
* @author Gabriel Roldan (TOPP) |
|
94 |
* @version $Id: EventType.java 21945 2008-06-30 14:04:53Z jpiera $ |
|
95 |
* @since 1.0 |
|
96 |
*/ |
|
97 |
public final class EventType { |
|
98 |
|
|
99 |
private boolean isValueEvent; |
|
100 |
|
|
101 |
private int code; |
|
102 |
|
|
103 |
/** |
|
104 |
* Private default constructor inforces the use of this class by its public static members only |
|
105 |
*/ |
|
106 |
private EventType(final int code) { |
|
107 |
this(code, false); |
|
108 |
} |
|
109 |
|
|
110 |
private EventType(final int code, boolean isValue) { |
|
111 |
this.code = code; |
|
112 |
this.isValueEvent = isValue; |
|
113 |
} |
|
114 |
|
|
115 |
public static final int NONE_CODE = 0; |
|
116 |
|
|
117 |
/** |
|
118 |
* Null object to indicate either a document has not started being parsed yet, or a document has |
|
119 |
* not started being written yet. |
|
120 |
*/ |
|
121 |
public static final EventType NONE = new EventType(NONE_CODE); |
|
122 |
|
|
123 |
public static final int START_DOCUMENT_CODE = 1; |
|
124 |
/** |
|
125 |
* Indicates the parser is positioned at the start of the document. The next call to |
|
126 |
* {@link IXmlStreamReader#next()} shall return either {@link #START_ELEMENT}, {@link #COMMENT} |
|
127 |
* or {@link #END_DOCUMENT} if the document is empty. |
|
128 |
*/ |
|
129 |
public static final EventType START_DOCUMENT = new EventType(START_DOCUMENT_CODE); |
|
130 |
|
|
131 |
public static final int END_DOCUMENT_CODE = 2; |
|
132 |
|
|
133 |
/** |
|
134 |
* Indicates the parser has reached the end of the bxml document |
|
135 |
*/ |
|
136 |
public static final EventType END_DOCUMENT = new EventType(END_DOCUMENT_CODE); |
|
137 |
|
|
138 |
public static final int START_ELEMENT_CODE = 3; |
|
139 |
|
|
140 |
/** |
|
141 |
* Signals the opening of an element tag. |
|
142 |
*/ |
|
143 |
public static final EventType START_ELEMENT = new EventType(START_ELEMENT_CODE); |
|
144 |
|
|
145 |
public static final int END_ELEMENT_CODE = 4; |
|
146 |
|
|
147 |
/** |
|
148 |
* Signals the end of the current element. No content elements such as {@code <element/>} and |
|
149 |
* {@code <element att="attval"/>} will be notified by an START_ELEMENT and END_ELEMENT event |
|
150 |
* with no value event in between, to preserve semantic equivalence with the |
|
151 |
* {@code <element></element>} tag sequence. |
|
152 |
*/ |
|
153 |
public static final EventType END_ELEMENT = new EventType(END_ELEMENT_CODE); |
|
154 |
|
|
155 |
public static final int VALUE_BOOL_CODE = 5; |
|
156 |
|
|
157 |
/** |
|
158 |
* Content event that indicates the parser is at a value token whose content is either a Java |
|
159 |
* boolean or an array of booleans. |
|
160 |
*/ |
|
161 |
public static final EventType VALUE_BOOL = new EventType(VALUE_BOOL_CODE, true); |
|
162 |
|
|
163 |
public static final int VALUE_BYTE_CODE = 6; |
|
164 |
|
|
165 |
/** |
|
166 |
* Content event that indicates the parser is at a value token whose content is either a Java |
|
167 |
* byte or an array of bytes. |
|
168 |
*/ |
|
169 |
public static final EventType VALUE_BYTE = new EventType(VALUE_BYTE_CODE, true); |
|
170 |
|
|
171 |
public static final int VALUE_INT_CODE = 7; |
|
172 |
|
|
173 |
/** |
|
174 |
* Content event that indicates the parser is at a value token whose content is either a Java |
|
175 |
* integer or an array of integers. For the sake of simplicity, the low level {@code SmallNum}, |
|
176 |
* {@code Short}, {@code UShort}, and {@code Int} value types are mapped to this event type. |
|
177 |
*/ |
|
178 |
public static final EventType VALUE_INT = new EventType(VALUE_INT_CODE, true); |
|
179 |
|
|
180 |
public static final int VALUE_LONG_CODE = 8; |
|
181 |
|
|
182 |
/** |
|
183 |
* Content event that indicates the parser is at a value token whose content is either a Java |
|
184 |
* long or an array of longs. |
|
185 |
*/ |
|
186 |
public static final EventType VALUE_LONG = new EventType(VALUE_LONG_CODE, true); |
|
187 |
|
|
188 |
public static final int VALUE_FLOAT_CODE = 9; |
|
189 |
|
|
190 |
/** |
|
191 |
* Content event that indicates the parser is at a value token whose content is either a Java |
|
192 |
* float or an array of floats. |
|
193 |
*/ |
|
194 |
public static final EventType VALUE_FLOAT = new EventType(VALUE_FLOAT_CODE, true); |
|
195 |
|
|
196 |
public static final int VALUE_DOUBLE_CODE = 10; |
|
197 |
|
|
198 |
/** |
|
199 |
* Content event that indicates the parser is at a value token whose content is either a Java |
|
200 |
* double or an array of double. |
|
201 |
*/ |
|
202 |
public static final EventType VALUE_DOUBLE = new EventType(VALUE_DOUBLE_CODE, true); |
|
203 |
|
|
204 |
public static final int VALUE_STRING_CODE = 11; |
|
205 |
/** |
|
206 |
* Content event that indicates the parser is at a value token whose content is a Java String. |
|
207 |
* There are no such a structure as an array of Strings in the BXML spec. |
|
208 |
*/ |
|
209 |
public static final EventType VALUE_STRING = new EventType(VALUE_STRING_CODE, true); |
|
210 |
|
|
211 |
public static final int VALUE_CDATA_CODE = 12; |
|
212 |
|
|
213 |
/** |
|
214 |
* This is event equivalent to the {@code "<![CDATA[content]]>"} structure in textual XML, |
|
215 |
* signaled by the CDataSectionToken. This token is essentially equivalent to the |
|
216 |
* CharContentToken, except that its use may be regarded as a hint to a translator to regenerate |
|
217 |
* a CDATA section in textual XML. |
|
218 |
*/ |
|
219 |
public static final EventType VALUE_CDATA = new EventType(VALUE_CDATA_CODE, true); |
|
220 |
|
|
221 |
public static final int VALUE_SPACE_CODE = 13; |
|
222 |
|
|
223 |
/** |
|
224 |
* Content event that signals the precense of a WhiteSpace token. That is, a potentially |
|
225 |
* insignificant sequence of white space or newline characters |
|
226 |
*/ |
|
227 |
public static final EventType SPACE = new EventType(VALUE_SPACE_CODE, true); |
|
228 |
|
|
229 |
public static final int COMMENT_CODE = 14; |
|
230 |
|
|
231 |
/** |
|
232 |
* Indicates the parser is at a XML comment token |
|
233 |
*/ |
|
234 |
public static final EventType COMMENT = new EventType(COMMENT_CODE); |
|
235 |
|
|
236 |
public static final int ATTRIBUTE_CODE = 15; |
|
237 |
|
|
238 |
/** |
|
239 |
* Used only for writing attributes. |
|
240 |
* |
|
241 |
* @see IXmlStreamWriter#writeStartAttribute(String, String) |
|
242 |
*/ |
|
243 |
public static final EventType ATTRIBUTE = new EventType(ATTRIBUTE_CODE); |
|
244 |
|
|
245 |
public static final int ATTRIBUTES_END_CODE = 16; |
|
246 |
|
|
247 |
/** |
|
248 |
* Used only for writing attributes. |
|
249 |
* |
|
250 |
* @see IXmlStreamWriter#writeEndAttributes() |
|
251 |
*/ |
|
252 |
public static final EventType ATTRIBUTES_END = new EventType(ATTRIBUTES_END_CODE); |
|
253 |
|
|
254 |
public int getCode() { |
|
255 |
return code; |
|
256 |
} |
|
257 |
|
|
258 |
/** |
|
259 |
* Convenience method that returns whether this EventType represents a value token |
|
260 |
* |
|
261 |
* @return {@code true} if {@code eventType} is one of |
|
262 |
* {@code VALUE_BOOL, VALUE_BYTE, VALUE_INT, VALUE_LONG, VALUE_FLOAT, VALUE_DOUBLE, |
|
263 |
* VALUE_STRING, VALUE_CDATA, SPACE} |
|
264 |
*/ |
|
265 |
public boolean isValue() { |
|
266 |
return isValueEvent; |
|
267 |
} |
|
268 |
|
|
269 |
/** |
|
270 |
* Convenience method that returns whether this EventType represents a tag element |
|
271 |
* |
|
272 |
* @return {@code true} if {@code eventType} is one of {@code START_ELEMENT, END_ELEMENT} |
|
273 |
*/ |
|
274 |
public boolean isTag() { |
|
275 |
return START_ELEMENT == this || END_ELEMENT == this; |
|
276 |
} |
|
277 |
} |
|
0 | 278 |
org.gvsig.xmlpull/library/tags/org.gvsig.xmlpull-2.0.33/org.gvsig.xmlpull.lib/org.gvsig.xmlpull.lib.api/src/main/java/org/gvsig/xmlpull/lib/api/stream/AbstractXmlStreamReaderWrapper.java | ||
---|---|---|
1 |
/* gvSIG. Sistem a de Informaci?n Geogr?fica de la Generalitat Valenciana |
|
2 |
* |
|
3 |
* Copyright (C) 2007 Generalitat Valenciana. |
|
4 |
* |
|
5 |
* This program is free software; you can redistribute it and/or |
|
6 |
* modify it under the terms of the GNU General Public License |
|
7 |
* as published by the Free Software Foundation; either version 2 |
|
8 |
* of the License, or (at your option) any later version. |
|
9 |
* |
|
10 |
* This program is distributed in the hope that it will be useful, |
|
11 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
12 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
13 |
* GNU General Public License for more details. |
|
14 |
* |
|
15 |
* You should have received a copy of the GNU General Public License |
|
16 |
* along with this program; if not, write to the Free Software |
|
17 |
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,USA. |
|
18 |
* |
|
19 |
* For more information, contact: |
|
20 |
* |
|
21 |
* Generalitat Valenciana |
|
22 |
* Conselleria d'Infraestructures i Transport |
|
23 |
* Av. Blasco Ib??ez, 50 |
|
24 |
* 46010 VALENCIA |
|
25 |
* SPAIN |
|
26 |
* |
|
27 |
* +34 9638 62 495 |
|
28 |
* gvsig@gva.es |
|
29 |
* www.gvsig.gva.es |
|
30 |
*/ |
|
31 |
package org.gvsig.xmlpull.lib.api.stream; |
|
32 |
|
|
33 |
/** |
|
34 |
* Plain wrapper for an {@link IXmlStreamReader} aimed at easying the creation of IXmlStreamReader |
|
35 |
* decorators. |
|
36 |
* <p> |
|
37 |
* This class is a pure abstract wrapper, so all methods delegate to the wrapped object. |
|
38 |
* </p> |
|
39 |
* |
|
40 |
* @author Gabriel Roldan (TOPP) |
|
41 |
* @version $Id: AbstractXmlStreamReaderWrapper.java 20425 2008-05-05 14:24:58Z groldan $ |
|
42 |
*/ |
|
43 |
public abstract class AbstractXmlStreamReaderWrapper implements IXmlStreamReader { |
|
44 |
|
|
45 |
private IXmlStreamReader wrapped; |
|
46 |
|
|
47 |
protected AbstractXmlStreamReaderWrapper() { |
|
48 |
// do nothing |
|
49 |
} |
|
50 |
|
|
51 |
protected AbstractXmlStreamReaderWrapper(IXmlStreamReader wrapped) { |
|
52 |
setWrapped(wrapped); |
|
53 |
} |
|
54 |
|
|
55 |
public void setWrapped(IXmlStreamReader wrapped) { |
|
56 |
this.wrapped = wrapped; |
|
57 |
} |
|
58 |
|
|
59 |
/** |
|
60 |
* @see org.gvsig.gpe.xml.stream.IXmlStreamReader#getAttributeCount() |
|
61 |
*/ |
|
62 |
public int getAttributeCount() throws XmlStreamException { |
|
63 |
return wrapped.getAttributeCount(); |
|
64 |
} |
|
65 |
|
|
66 |
/** |
|
67 |
* @see org.gvsig.gpe.xml.stream.IXmlStreamReader#getAttributeName(int) |
|
68 |
*/ |
|
69 |
public IQName getAttributeName(int i) throws XmlStreamException { |
|
70 |
return wrapped.getAttributeName(i); |
|
71 |
} |
|
72 |
|
|
73 |
/** |
|
74 |
* @param i |
|
75 |
* @see org.gvsig.gpe.xml.stream.IXmlStreamReader#getAttributeValue(int) |
|
76 |
*/ |
|
77 |
public String getAttributeValue(int i) throws XmlStreamException { |
|
78 |
return wrapped.getAttributeValue(i); |
|
79 |
} |
|
80 |
|
|
81 |
/** |
|
82 |
* @see org.gvsig.gpe.xml.stream.IXmlStreamReader#getEventType() |
|
83 |
*/ |
|
84 |
public int getEventType() throws XmlStreamException { |
|
85 |
return wrapped.getEventType(); |
|
86 |
} |
|
87 |
|
|
88 |
/** |
|
89 |
* @see org.gvsig.gpe.xml.stream.IXmlStreamReader#getName() |
|
90 |
*/ |
|
91 |
public IQName getName() throws XmlStreamException { |
|
92 |
return wrapped.getName(); |
|
93 |
} |
|
94 |
|
|
95 |
/** |
|
96 |
* @see org.gvsig.gpe.xml.stream.IXmlStreamReader#getText() |
|
97 |
*/ |
|
98 |
public String getText() throws XmlStreamException { |
|
99 |
return wrapped.getText(); |
|
100 |
} |
|
101 |
|
|
102 |
/** |
|
103 |
* @see org.gvsig.gpe.xml.stream.IXmlStreamReader#isWhitespace() |
|
104 |
*/ |
|
105 |
public boolean isWhitespace() throws XmlStreamException { |
|
106 |
return wrapped.isWhitespace(); |
|
107 |
} |
|
108 |
|
|
109 |
/** |
|
110 |
* @see org.gvsig.gpe.xml.stream.IXmlStreamReader#next() |
|
111 |
*/ |
|
112 |
public int next() throws XmlStreamException { |
|
113 |
return wrapped.next(); |
|
114 |
} |
|
115 |
|
|
116 |
/** |
|
117 |
* @see org.gvsig.gpe.xml.stream.IXmlStreamReader#nextTag() |
Also available in: Unified diff