Package org.apache.juneau.marshall.jena

Class RdfSerializer

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.MarshallingTraverseContext

org.apache.juneau.marshall.serializer.Serializer

org.apache.juneau.marshall.serializer.WriterSerializer

org.apache.juneau.marshall.jena.RdfSerializer

All Implemented Interfaces:

Function<Object,String>, ThrowingFunction<Object,String>, RdfMetaProvider, XmlMetaProvider

Direct Known Subclasses:

JsonLdSerializer, N3Serializer, NQuadsSerializer, NTripleSerializer, RdfJsonSerializer, RdfXmlAbbrevSerializer, RdfXmlSerializer, TriGSerializer, TriXSerializer, TurtleSerializer

public class RdfSerializer
extends WriterSerializer
implements RdfMetaProvider

Serializes POJOs to RDF.

Behavior-specific subclasses

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

• RdfXmlSerializer - RDF/XML.
• RdfXmlAbbrevSerializer - RDF/XML-ABBREV.
• NTripleSerializer - N-TRIPLE.
• TurtleSerializer - TURTLE.
• N3Serializer - N3.

Notes:

• This class is thread safe and reusable.

See Also:

• {doc jmr.RdfDetails}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RdfSerializer.Builder<SELF extends RdfSerializer.Builder<SELF>>	Builder class.
static final class	RdfSerializer.DefaultBuilder	Concrete default builder leaf for the non-subclassed create() / copy() path.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.serializer.Serializer

Serializer.Null

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	addBeanTypesRdf
protected final boolean	addLiteralTypes
protected final boolean	addRootProperty
protected final boolean	autoDetectNamespaces
protected final RdfCollectionFormat	collectionFormat
protected final Namespace	juneauBpNs
protected final Namespace	juneauNs
protected final String	language
protected final boolean	looseCollections
protected final boolean	useXmlNamespaces

Fields inherited from class org.apache.juneau.marshall.serializer.WriterSerializer

maxIndent, quoteChar, quoteCharOverride, useWhitespace

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

accept, addBeanTypes, addRootType, keepNullProperties, listener, nonDefault, produces, sortCollections, sortMaps, trimEmptyCollections, trimEmptyMaps, trimStrings

Fields inherited from class org.apache.juneau.marshall.MarshallingContextable

marshallingContext

Fields inherited from class org.apache.juneau.marshall.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Constructor	Description
RdfSerializer(RdfSerializer.Builder<?> builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
RdfSerializer.Builder<?>	copy()	Creates a builder from this context object.
static RdfSerializer.Builder<?>	create()	Creates a new builder for this object.
RdfSerializerSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
protected final RdfCollectionFormat	getCollectionFormat()	RDF format for representing collections and arrays.
protected final Map<String,Object>	getJenaSettings()	All Jena-related configuration properties.
protected final Namespace	getJuneauBpNs()	Default XML namespace for bean properties.
protected final Namespace	getJuneauNs()	XML namespace for Juneau properties.
protected final String	getLanguage()	RDF language.
Namespace[]	getNamespaces()	Default namespaces.
RdfBeanMeta	getRdfBeanMeta(BeanMeta<?> bm)	Returns the language-specific metadata on the specified bean.
RdfBeanPropertyMeta	getRdfBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
RdfClassMeta	getRdfClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
RdfSerializerSession	getSession()	Returns a session to use for this context.
XmlBeanMeta	getXmlBeanMeta(BeanMeta<?> bm)	Returns the language-specific metadata on the specified bean.
XmlBeanPropertyMeta	getXmlBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
XmlClassMeta	getXmlClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
protected final boolean	isAddBeanTypes()	Add "_type" properties when needed.
protected final boolean	isAddLiteralTypes()	Add XSI data types to non-String literals.
protected final boolean	isAddRootProp()	Add RDF root identifier property to root node.
protected final boolean	isAutoDetectNamespaces()	Auto-detect namespace usage.
protected final boolean	isLooseCollections()	Collections should be serialized and parsed as loose collections.
protected final boolean	isUseXmlNamespaces()	Reuse XML namespaces when RDF namespaces not specified.
protected FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.

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

applyThrows, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, println, quoteChar, toString, write

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

createSerializerBuilder, doWrite, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, isAddRootType, isKeepNullProperties, isNonDefault, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, write, writeToString

Methods inherited from class org.apache.juneau.marshall.MarshallingTraverseContext

getDetectRecursions, getIgnoreRecursions, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions, shouldDetectRecursions

Methods inherited from class org.apache.juneau.marshall.MarshallingContextable

getDurationFormat, getMarshallingContext, getPeriodFormat

Methods inherited from class org.apache.juneau.marshall.Context

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface org.apache.juneau.commons.function.ThrowingFunction

apply

Field Details

addBeanTypesRdf

protected final boolean addBeanTypesRdf

addLiteralTypes

protected final boolean addLiteralTypes

addRootProperty

protected final boolean addRootProperty

autoDetectNamespaces

protected final boolean autoDetectNamespaces

looseCollections

protected final boolean looseCollections

useXmlNamespaces

protected final boolean useXmlNamespaces

juneauBpNs

protected final Namespace juneauBpNs

juneauNs

protected final Namespace juneauNs

collectionFormat

protected final RdfCollectionFormat collectionFormat

language

protected final String language

Constructor Details

RdfSerializer

public RdfSerializer(RdfSerializer.Builder<?> builder)

Constructor.

Parameters:

builder - The builder for this object.
Cannot be null.

Method Details

create

public static RdfSerializer.Builder<?> create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public RdfSerializer.Builder<?> copy()

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:

copy in class WriterSerializer

Returns:

A new Builder object.

createSession

public RdfSerializerSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class WriterSerializer

Returns:

A new session builder.

getNamespaces

public Namespace[] getNamespaces()

Default namespaces.

Returns:

The default list of namespaces associated with this serializer.

See Also:

• RdfSerializer.Builder.namespaces(Namespace...)

getRdfBeanMeta

public RdfBeanMeta getRdfBeanMeta(BeanMeta<?> bm)

Description copied from interface: RdfMetaProvider

Returns the language-specific metadata on the specified bean.

Specified by:

getRdfBeanMeta in interface RdfMetaProvider

Parameters:

bm - The bean to return the metadata on.

Returns:

The metadata.

getRdfBeanPropertyMeta

public RdfBeanPropertyMeta getRdfBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: RdfMetaProvider

Returns the language-specific metadata on the specified bean property.

Specified by:

getRdfBeanPropertyMeta in interface RdfMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getRdfClassMeta

public RdfClassMeta getRdfClassMeta(ClassMeta<?> cm)

Description copied from interface: RdfMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getRdfClassMeta in interface RdfMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getSession

public RdfSerializerSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class WriterSerializer

Returns:

A new session object.

getXmlBeanMeta

public XmlBeanMeta getXmlBeanMeta(BeanMeta<?> bm)

Description copied from interface: XmlMetaProvider

Returns the language-specific metadata on the specified bean.

Specified by:

getXmlBeanMeta in interface XmlMetaProvider

Parameters:

bm - The bean to return the metadata on.

Returns:

The metadata.

getXmlBeanPropertyMeta

public XmlBeanPropertyMeta getXmlBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: XmlMetaProvider

Returns the language-specific metadata on the specified bean property.

Specified by:

getXmlBeanPropertyMeta in interface XmlMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getXmlClassMeta

public XmlClassMeta getXmlClassMeta(ClassMeta<?> cm)

Description copied from interface: XmlMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getXmlClassMeta in interface XmlMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getCollectionFormat

protected final RdfCollectionFormat getCollectionFormat()

RDF format for representing collections and arrays.

Returns:

RDF format for representing collections and arrays.

See Also:

• RdfSerializer.Builder.collectionFormat(RdfCollectionFormat)

getJenaSettings

protected final Map<String,Object> getJenaSettings()

All Jena-related configuration properties.

Returns:

A map of all Jena-related configuration properties.

getJuneauBpNs

protected final Namespace getJuneauBpNs()

Default XML namespace for bean properties.

Returns:

The XML namespace to use for bean properties.

See Also:

• RdfSerializer.Builder.juneauBpNs(Namespace)

getJuneauNs

protected final Namespace getJuneauNs()

XML namespace for Juneau properties.

Returns:

The XML namespace to use for Juneau properties.

See Also:

• RdfSerializer.Builder.juneauNs(Namespace)

getLanguage

protected final String getLanguage()

RDF language.

Returns:

The RDF language to use.

See Also:

• RdfSerializer.Builder.language(String)

isAddBeanTypes

protected final boolean isAddBeanTypes()

Add "_type" properties when needed.

Overrides:

isAddBeanTypes in class Serializer

Returns:

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

See Also:

• Serializer.Builder.addBeanTypes()

isAddLiteralTypes

protected final boolean isAddLiteralTypes()

Add XSI data types to non-String literals.

Returns:

true if XSI data types should be added to string literals.

See Also:

• RdfSerializer.Builder.addLiteralTypes()

isAddRootProp

protected final boolean isAddRootProp()

Add RDF root identifier property to root node.

Returns:

true if RDF property http://www.apache.org/juneau/root is added with a value of "true" to identify the root node in the graph.

See Also:

• RdfSerializer.Builder.addRootProperty()

isAutoDetectNamespaces

protected final boolean isAutoDetectNamespaces()

Auto-detect namespace usage.

Returns:

true if namespaces usage should be detected before serialization.

See Also:

• RdfSerializer.Builder.disableAutoDetectNamespaces()

isLooseCollections

protected final boolean isLooseCollections()

Collections should be serialized and parsed as loose collections.

Returns:

true if collections of resources are handled as loose collections of resources in RDF instead of resources that are children of an RDF collection (e.g. Sequence, Bag).

See Also:

• RdfSerializer.Builder.looseCollections()

isUseXmlNamespaces

protected final boolean isUseXmlNamespaces()

Reuse XML namespaces when RDF namespaces not specified.

Returns:

true if namespaces defined using @XmlNs and @Xml will be inherited by the RDF serializers.
Otherwise, namespaces will be defined using @RdfNs and @Rdf.

See Also:

• RdfSerializer.Builder.disableUseXmlNamespaces()

properties

protected FluentMap<String,Object> properties()

Description copied from class: Context

Returns the properties on this bean as a map for debugging.

Overrides:

properties in class WriterSerializer

Returns:

The properties on this bean as a map for debugging.