org.apache.juneau.jena

Class RdfSerializer

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContext

org.apache.juneau.BeanTraverseContext

org.apache.juneau.serializer.Serializer

org.apache.juneau.serializer.WriterSerializer

org.apache.juneau.jena.RdfSerializer

All Implemented Interfaces:

RdfCommon

Direct Known Subclasses:

N3Serializer, NTripleSerializer, RdfXmlAbbrevSerializer, RdfXmlSerializer, TurtleSerializer

@ConfigurableContext(prefixes={"RdfCommon","RdfSerializer"})
public class RdfSerializer
extends WriterSerializer
implements RdfCommon

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.

• Overview > juneau-marshall-rdf

Field Summary

Fields

Modifier and Type	Field and Description
static String	RDF_addBeanTypes 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.
static String	RDF_useXmlNamespaces Configuration property: Reuse XML namespaces when RDF namespaces not specified.

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

WSERIALIZER_fileCharset, WSERIALIZER_maxIndent, WSERIALIZER_quoteChar, WSERIALIZER_streamCharset, WSERIALIZER_useWhitespace

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

SERIALIZER_addBeanTypes, SERIALIZER_addRootType, SERIALIZER_listener, SERIALIZER_sortCollections, SERIALIZER_sortMaps, SERIALIZER_trimEmptyCollections, SERIALIZER_trimEmptyMaps, SERIALIZER_trimNullProperties, SERIALIZER_trimStrings, SERIALIZER_uriContext, SERIALIZER_uriRelativity, SERIALIZER_uriResolution

Fields inherited from class org.apache.juneau.BeanTraverseContext

BEANTRAVERSE_detectRecursions, BEANTRAVERSE_ignoreRecursions, BEANTRAVERSE_initialDepth, BEANTRAVERSE_maxDepth

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_bpi, BEAN_bpro, BEAN_bpwo, BEAN_bpx, BEAN_debug, BEAN_examples, BEAN_excludeProperties, BEAN_fluentSetters, 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_useEnumNames, 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

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
RdfSerializerBuilder	builder() Creates a builder from this context object.
static RdfSerializerBuilder	create() Instantiates a new clean-slate RdfSerializerBuilder object.
RdfSerializerSession	createSession() Create a new bean session based on the properties defined on this context.
RdfSerializerSession	createSession(SerializerSessionArgs args) Create the session object used for actual serialization of objects.
protected RdfCollectionFormat	getCollectionFormat() Configuration property: RDF format for representing collections and arrays.
protected Map<String,Object>	getJenaProperties() Configuration property: All Jena-related configuration properties.
protected Namespace	getJuneauBpNs() Configuration property: Default XML namespace for bean properties.
protected Namespace	getJuneauNs() Configuration property: XML namespace for Juneau properties.
protected String	getLanguage() Configuration property: RDF language.
Namespace[]	getNamespaces() Configuration property: Default namespaces.
protected boolean	isAddBeanTypes() Configuration property: Add "_type" properties when needed.
protected boolean	isAddLiteralTypes() Configuration property: Add XSI data types to non-String literals.
protected boolean	isAddRootProp() Configuration property: Add RDF root identifier property to root node.
protected boolean	isAutoDetectNamespaces() Configuration property: Auto-detect namespace usage.
protected boolean	isLooseCollections() Configuration property: Collections should be serialized and parsed as loose collections.
protected boolean	isUseXmlNamespaces() Configuration property: Reuse XML namespaces when RDF namespaces not specified.
ObjectMap	toMap() Returns the properties defined on this bean context as a simple map for debugging purposes.

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

getFileCharset, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, println, serialize, toString, toStringObject

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

createDefaultSessionArgs, getAcceptMediaTypes, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getUriContext, getUriRelativity, getUriResolution, isAddRootType, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimNullProperties, isTrimStrings, serialize, serializeToString

Methods inherited from class org.apache.juneau.BeanTraverseContext

createSession, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions

Methods inherited from class org.apache.juneau.BeanContext

_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, dumpCacheStats, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBpi, getBpi, getBpro, getBpro, getBpwo, getBpwo, getBpx, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getExamples, getImplClassConstructor, getImplClasses, getLocale, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPojoSwaps, getPropertyNamer, getTimeZone, hasSameCache, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isNotABean, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, object, resolveClassMeta, string

Methods inherited from class org.apache.juneau.Context

equals, getArrayProperty, getArrayProperty, getBooleanProperty, getCdlProperty, 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, getStringPropertyWithNone, hashCode, identityCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

RDF_addBeanTypes

public static final String RDF_addBeanTypes

Configuration property: Add "_type" properties when needed.

Property:

• Name: "RdfSerializer.addBeanTypes.b"
• Data type: Boolean
• Default: false
• Session property: false
• Methods:
  • RdfSerializerBuilder.addBeanTypes(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_addBeanTypes 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 property: false
• 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 property: false
• 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 property: false
• 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 property: false
• Annotations:
  • Rdf.namespace()
• Methods:
  • RdfSerializerBuilder.namespaces(Namespace...)

Description:

The default list of namespaces associated with this serializer.

See Also:

Constant Field Values

RDF_useXmlNamespaces

public static final String RDF_useXmlNamespaces

Configuration property: Reuse XML namespaces when RDF namespaces not specified.

Property:

• Name: "Rdf.useXmlNamespaces.b"
• Data type: Boolean
• Default: true
• Methods:
  • RdfSerializerBuilder.useXmlNamespaces(boolean)

Description:

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

See Also:

Constant Field Values

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");

The accept value can also contain q-values.

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 RdfSerializerSession createSession()

Description copied from class: BeanContext

Create a new bean session based on the properties defined on this context.

Use this method for creating sessions if you don't need to override any properties or locale/timezone currently set on this context.

Overrides:

createSession in class WriterSerializer

Returns:

A new session object.

createSession

public RdfSerializerSession 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.

getCollectionFormat

protected final RdfCollectionFormat getCollectionFormat()

Configuration property: RDF format for representing collections and arrays.

Returns:

RDF format for representing collections and arrays.

See Also:

RdfCommon.RDF_collectionFormat

getJuneauBpNs

protected final Namespace getJuneauBpNs()

Configuration property: Default XML namespace for bean properties.

Returns:

The XML namespace to use for bean properties.

See Also:

RdfCommon.RDF_juneauBpNs

getJuneauNs

protected final Namespace getJuneauNs()

Configuration property: XML namespace for Juneau properties.

Returns:

The XML namespace to use for Juneau properties.

See Also:

RdfCommon.RDF_juneauNs

getLanguage

protected final String getLanguage()

Configuration property: RDF language.

Returns:

The RDF language to use.

See Also:

RdfCommon.RDF_language

isLooseCollections

protected final boolean isLooseCollections()

Configuration property: 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:

RdfCommon.RDF_looseCollections

getJenaProperties

protected final Map<String,Object> getJenaProperties()

Configuration property: All Jena-related configuration properties.

Returns:

A map of all Jena-related configuration properties.

isAddBeanTypes

protected final boolean isAddBeanTypes()

Configuration property: 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:

RDF_addBeanTypes

isAddLiteralTypes

protected final boolean isAddLiteralTypes()

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

Returns:

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

See Also:

RDF_addLiteralTypes

isAddRootProp

protected final boolean isAddRootProp()

Configuration property: 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:

RDF_addRootProperty

isAutoDetectNamespaces

protected final boolean isAutoDetectNamespaces()

Configuration property: Auto-detect namespace usage.

Returns:

true if namespaces usage should be detected before serialization.

See Also:

RDF_autoDetectNamespaces

getNamespaces

public Namespace[] getNamespaces()

Configuration property: Default namespaces.

Returns:

The default list of namespaces associated with this serializer.

See Also:

RDF_namespaces

isUseXmlNamespaces

protected final boolean isUseXmlNamespaces()

Configuration property: 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:

RDF_useXmlNamespaces

toMap

public ObjectMap toMap()

Description copied from class: Context

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

Overrides:

toMap in class WriterSerializer

Returns:

A new map containing the properties defined on this context.