001: /*
002: * (c) Copyright 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Hewlett-Packard Development Company, LP
003: * All rights reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions
007: * are met:
008: * 1. Redistributions of source code must retain the above copyright
009: * notice, this list of conditions and the following disclaimer.
010: * 2. Redistributions in binary form must reproduce the above copyright
011: * notice, this list of conditions and the following disclaimer in the
012: * documentation and/or other materials provided with the distribution.
013: * 3. The name of the author may not be used to endorse or promote products
014: * derived from this software without specific prior written permission.
015:
016: * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
017: * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
018: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
019: * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
020: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
021: * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
022: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
023: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
024: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
025: * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
026: *
027: * $Id: RDFWriter.java,v 1.13 2008/01/02 12:05:48 andy_seaborne Exp $
028: */
029:
030: package com.hp.hpl.jena.rdf.model;
031:
032: import java.io.Writer;
033: import java.io.OutputStream;
034:
035: /** RDFWriter is an interface to RDF serializers.
036: *
037: * <p>An <code>RDFWriter</code> is a class which serializes an RDF model
038: * to some RDF serializaion language. RDF/XML, n-triple and n3 are
039: * examples of serialization languages.</p>
040: * @author bwm
041: * @version $Revision: 1.13 $
042: */
043: public interface RDFWriter {
044:
045: public static final String NSPREFIXPROPBASE = "com.hp.hpl.jena.nsprefix.";
046:
047: /** Caution: Serialize Model <code>model</code> to Writer <code>out</code>.
048: * It is often better to use an OutputStream and permit Jena
049: * to choose the character encoding. The charset restrictions
050: * on the Writer are defined by the different implementations
051: * of this interface. Typically using an OutputStreamWriter (e.g.
052: * a FileWriter) at least permits the implementation to
053: * examine the encoding. With an arbitrary Writer implementations
054: * assume a utf-8 encoding.
055: *
056: * @param out The Writer to which the serialization should
057: * be sent.
058: * @param model The model to be written.
059: * @param base the base URI for relative URI calculations. <code>
060: null</code> means use only absolute URI's.
061: */
062: public void write(Model model, Writer out, String base);
063:
064: /** Serialize Model <code>model</code> to OutputStream <code>out</out>.
065: * The implementation chooses the character encoding, utf-8 is preferred.
066: *
067: *
068: * @param out The OutputStream to which the serialization should be sent.
069: * @param model The model to be written.
070: * @param base the base URI for relative URI calculations. <code>
071: null</code> means use only absolute URI's. This is used for relative
072: URIs that would be resolved against the document retrieval URL.
073: Particular writers may include this value in the output.
074: */
075: public void write(Model model, OutputStream out, String base);
076:
077: /** Set a property to control the behaviour of this writer.
078: *
079: * <p>An RDFWriter's behaviour can be influenced by defining property values
080: * interpreted by that particular writer class. The values for such
081: * properties can be changed by calling this method. </p>
082: *
083: * <p>No standard properties are defined. For the properties recognised
084: * by any particular writer implementation, see the the documentation for
085: * that implementation. </p>
086: * <p>
087: * The built-in RDFWriters have properties as defined by:
088: * <dl>
089: * <dt>N3</dt><dt>N-TRIPLE</dt>
090: * <dd>No properties.</dd>
091: * <dt>RDF/XML</dt><dt>RDF/XML-ABBREV</dt>
092: * </dl>
093: * @return the old value for this property, or <code>null</code>
094: * if no value was set.
095: * @param propName The name of the property.
096: * @param propValue The new value of the property
097: */
098: public Object setProperty(String propName, Object propValue);
099:
100: /** Set an error handler.
101: * @param errHandler The new error handler to be used.
102: * @return the old error handler
103: */
104: public RDFErrorHandler setErrorHandler(RDFErrorHandler errHandler);
105: }
|