org.apache.juneau.jena

Class RdfSerializer

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContext

org.apache.juneau.serializer.Serializer

org.apache.juneau.serializer.WriterSerializer

org.apache.juneau.jena.RdfSerializer

All Implemented Interfaces:

RdfCommon

Direct Known Subclasses:

RdfSerializer.N3, RdfSerializer.NTriple, RdfSerializer.Turtle, RdfSerializer.Xml, RdfSerializer.XmlAbbrev

public class RdfSerializer
extends WriterSerializer
implements RdfCommon

Serializes POJOs to RDF.

Behavior-specific subclasses

The following direct subclasses are provided for language-specific serializers:

• RdfSerializer.Xml - RDF/XML.
• RdfSerializer.XmlAbbrev - RDF/XML-ABBREV.
• RdfSerializer.NTriple - N-TRIPLE.
• RdfSerializer.Turtle - TURTLE.
• RdfSerializer.N3 - N3.

See Also:

• org.apache.juneau.jena > RDF Overview

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RdfSerializer.N3 Produces N3 output
static class	RdfSerializer.NTriple Produces N-Triple output
static class	RdfSerializer.Turtle Produces Turtle output
static class	RdfSerializer.Xml Produces RDF/XML output
static class	RdfSerializer.XmlAbbrev Produces Abbreviated RDF/XML output

Field Summary

Fields

Modifier and Type	Field and Description
static RdfSerializer	DEFAULT_N3 Default N3 serializer, all default settings.
static RdfSerializer	DEFAULT_NTRIPLE Default N-Triple serializer, all default settings.
static RdfSerializer	DEFAULT_TURTLE Default Turtle serializer, all default settings.
static RdfSerializer	DEFAULT_XML Default RDF/XML serializer, all default settings.
static RdfSerializer	DEFAULT_XMLABBREV Default Abbreviated RDF/XML serializer, all default settings.
static String	RDF_addBeanTypeProperties Configuration property: Add "_type" properties when needed.
static String	RDF_addLiteralTypes Configuration property: Add XSI data types to non-String literals.
static String	RDF_addRootProperty Configuration property: Add RDF root identifier property to root node.
static String	RDF_autoDetectNamespaces Configuration property: Auto-detect namespace usage.
static String	RDF_namespaces Configuration property: Default namespaces.

Fields inherited from class org.apache.juneau.serializer.Serializer

SERIALIZER_abridged, SERIALIZER_addBeanTypeProperties, SERIALIZER_detectRecursions, SERIALIZER_ignoreRecursions, SERIALIZER_initialDepth, SERIALIZER_listener, SERIALIZER_maxDepth, SERIALIZER_maxIndent, SERIALIZER_quoteChar, SERIALIZER_sortCollections, SERIALIZER_sortMaps, SERIALIZER_trimEmptyCollections, SERIALIZER_trimEmptyMaps, SERIALIZER_trimNullProperties, SERIALIZER_trimStrings, SERIALIZER_uriContext, SERIALIZER_uriRelativity, SERIALIZER_uriResolution, SERIALIZER_useWhitespace

Fields inherited from class org.apache.juneau.BeanContext

BEAN_beanClassVisibility, BEAN_beanConstructorVisibility, BEAN_beanDictionary, BEAN_beanDictionary_add, BEAN_beanDictionary_remove, BEAN_beanFieldVisibility, BEAN_beanFilters, BEAN_beanFilters_add, BEAN_beanFilters_remove, BEAN_beanMapPutReturnsOldValue, BEAN_beanMethodVisibility, BEAN_beansRequireDefaultConstructor, BEAN_beansRequireSerializable, BEAN_beansRequireSettersForGetters, BEAN_beansRequireSomeProperties, BEAN_beanTypePropertyName, BEAN_debug, BEAN_excludeProperties, BEAN_ignoreInvocationExceptionsOnGetters, BEAN_ignoreInvocationExceptionsOnSetters, BEAN_ignorePropertiesWithoutSetters, BEAN_ignoreUnknownBeanProperties, BEAN_ignoreUnknownNullBeanProperties, BEAN_implClasses, BEAN_includeProperties, BEAN_locale, BEAN_mediaType, BEAN_notBeanClasses, BEAN_notBeanClasses_add, BEAN_notBeanClasses_remove, BEAN_notBeanPackages, BEAN_notBeanPackages_add, BEAN_notBeanPackages_remove, BEAN_pojoSwaps, BEAN_pojoSwaps_add, BEAN_pojoSwaps_remove, BEAN_propertyNamer, BEAN_sortProperties, BEAN_timeZone, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED

Fields inherited from interface org.apache.juneau.jena.RdfCommon

LANG_PROP_MAP, RDF_arp_embedding, RDF_arp_err_, RDF_arp_errorMode, RDF_arp_ign_, RDF_arp_iriRules, RDF_arp_warn_, RDF_collectionFormat, RDF_juneauBpNs, RDF_juneauNs, RDF_language, RDF_looseCollections, RDF_n3_abbrevBaseUri, RDF_n3_indentProperty, RDF_n3_minGap, RDF_n3_objectLists, RDF_n3_propertyColumn, RDF_n3_subjectColumn, RDF_n3_useDoubles, RDF_n3_usePropertySymbols, RDF_n3_useTripleQuotedStrings, RDF_n3_widePropertyLen, RDF_rdfxml_allowBadUris, RDF_rdfxml_attributeQuoteChar, RDF_rdfxml_blockRules, RDF_rdfxml_longId, RDF_rdfxml_relativeUris, RDF_rdfxml_showDoctypeDeclaration, RDF_rdfxml_showXmlDeclaration, RDF_rdfxml_tab, RDF_rdfxml_xmlBase, RDF_useXmlNamespaces

Constructor Summary

Constructors

Constructor and Description
RdfSerializer(PropertyStore ps) Constructor.
RdfSerializer(PropertyStore ps, String produces, String... accept) Constructor.

Method Summary

Modifier and Type	Method and Description
ObjectMap	asMap() Returns the properties defined on this bean context as a simple map for debugging purposes.
RdfSerializerBuilder	builder() Creates a builder from this context object.
static RdfSerializerBuilder	create() Instantiates a new clean-slate RdfSerializerBuilder object.
WriterSerializerSession	createSession(SerializerSessionArgs args) Create the session object used for actual serialization of objects.

Methods inherited from class org.apache.juneau.serializer.WriterSerializer

isWriterSerializer, println, serialize, toString, toStringObject

Methods inherited from class org.apache.juneau.serializer.Serializer

createDefaultSessionArgs, createSession, getMediaTypes, getResponseContentType, serialize

Methods inherited from class org.apache.juneau.BeanContext

_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, createSession, dumpCacheStats, getBeanMeta, getBeanRegistry, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getExcludeProperties, getImplClassConstructor, getIncludeProperties, hasSameCache, isBean, isNotABean, newInstance, newInstance, newInstanceFromOuter, object, resolveClassMeta, string

Methods inherited from class org.apache.juneau.Context

equals, getArrayProperty, getArrayProperty, getBooleanProperty, getClassArrayProperty, getClassArrayProperty, getClassArrayProperty, getClassListProperty, getClassListProperty, getClassMapProperty, getClassMapProperty, getClassProperty, getClassSetProperty, getClassSetProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceProperty, getInstanceProperty, getInstanceProperty, getIntegerProperty, getListProperty, getListProperty, getLongProperty, getMapProperty, getProperty, getProperty, getPropertyKeys, getPropertyStore, getSetProperty, getSetProperty, getStringProperty, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RDF_addBeanTypeProperties

public static final String RDF_addBeanTypeProperties

Configuration property: Add "_type" properties when needed.

Property:

• Name: "RdfSerializer.addBeanTypeProperties.b"
• Data type: Boolean
• Default: false
• Session-overridable: true
• Methods:
  • RdfSerializerBuilder.addBeanTypeProperties(boolean)

Description:

If true, then "_type" properties will be added to beans if their type cannot be inferred through reflection.

When present, this value overrides the Serializer.SERIALIZER_addBeanTypeProperties setting and is provided to customize the behavior of specific serializers in a SerializerGroup.

See Also:

Constant Field Values

RDF_addLiteralTypes

public static final String RDF_addLiteralTypes

Configuration property: Add XSI data types to non-String literals.

Property:

• Name: "RdfSerializer.addLiteralTypes.b"
• Data type: Boolean
• Default: false
• Session-overridable: true
• Methods:
  • RdfSerializerBuilder.addLiteralTypes(boolean)
  • RdfSerializerBuilder.addLiteralTypes()

See Also:

Constant Field Values

RDF_addRootProperty

public static final String RDF_addRootProperty

Configuration property: Add RDF root identifier property to root node.

Property:

• Name: "RdfSerializer.addRootProperty.b"
• Data type: Boolean
• Default: false
• Session-overridable: true
• Methods:
  • RdfSerializerBuilder.addRootProperty(boolean)
  • RdfSerializerBuilder.addRootProperty()

Description:

When enabled an RDF property http://www.apache.org/juneau/root is added with a value of "true" to identify the root node in the graph.
This helps locate the root node during parsing.

If disabled, the parser has to search through the model to find any resources without incoming predicates to identify root notes, which can introduce a considerable performance degradation.

See Also:

Constant Field Values

RDF_autoDetectNamespaces

public static final String RDF_autoDetectNamespaces

Configuration property: Auto-detect namespace usage.

Property:

• Name: "RdfSerializer.autoDetectNamespaces.b"
• Data type: Boolean
• Default: true
• Session-overridable: true
• Methods:
  • RdfSerializerBuilder.autoDetectNamespaces(boolean)

Description:

Detect namespace usage before serialization.

If enabled, then the data structure will first be crawled looking for namespaces that will be encountered before the root element is serialized.

See Also:

Constant Field Values

RDF_namespaces

public static final String RDF_namespaces

Configuration property: Default namespaces.

Property:

• Name: "RdfSerializer.namespaces.ls"
• Data type: List<String> (serialized Namespace objects)
• Default: empty list
• Session-overridable: true
• Annotations:
  • Rdf.namespace()
• Methods:
  • RdfSerializerBuilder.namespaces(Namespace...)

Description:

The default list of namespaces associated with this serializer.

See Also:

Constant Field Values

DEFAULT_XML

public static final RdfSerializer DEFAULT_XML

Default RDF/XML serializer, all default settings.

DEFAULT_XMLABBREV

public static final RdfSerializer DEFAULT_XMLABBREV

Default Abbreviated RDF/XML serializer, all default settings.

DEFAULT_TURTLE

public static final RdfSerializer DEFAULT_TURTLE

Default Turtle serializer, all default settings.

DEFAULT_NTRIPLE

public static final RdfSerializer DEFAULT_NTRIPLE

Default N-Triple serializer, all default settings.

DEFAULT_N3

public static final RdfSerializer DEFAULT_N3

Default N3 serializer, all default settings.

Constructor Detail

RdfSerializer

public RdfSerializer(PropertyStore ps,
                     String produces,
                     String... accept)

Constructor.

Parameters:

ps - The property store containing all the settings for this object.

produces - The media type that this serializer produces.

accept - The accept media types that the serializer can handle.

Can contain meta-characters per the media-type specification of RFC2616/14.1

If empty, then assumes the only media type supported is produces.

For example, if this serializer produces "application/json" but should handle media types of "application/json" and "text/json", then the arguments should be:

super(ps, "application/json", "application/json", "text/json");

...or...

super(ps, "application/json", "*/json");

RdfSerializer

public RdfSerializer(PropertyStore ps)

Constructor.

Parameters:

ps - The property store containing all the settings for this object.

Method Detail

builder

public RdfSerializerBuilder builder()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

builder in class Serializer

Returns:

A new ContextBuilder object.

create

public static RdfSerializerBuilder create()

Instantiates a new clean-slate RdfSerializerBuilder object.

This is equivalent to simply calling new RdfSerializerBuilder().

Note that this method creates a builder initialized to all default settings, whereas builder() copies the settings of the object called on.

Returns:

A new RdfSerializerBuilder object.

createSession

public WriterSerializerSession createSession(SerializerSessionArgs args)

Description copied from class: Serializer

Create the session object used for actual serialization of objects.

Specified by:

createSession in class WriterSerializer

Parameters:

args - Runtime arguments. These specify session-level information such as locale and URI context. It also include session-level properties that override the properties defined on the bean and serializer contexts.

Returns:

The new session object.

asMap

public ObjectMap asMap()

Description copied from class: Context

Returns the properties defined on this bean context as a simple map for debugging purposes.

Overrides:

asMap in class Serializer

Returns:

A new map containing the properties defined on this context.