org.apache.juneau.jena

Interface RdfCommon

All Known Implementing Classes:

N3Parser, N3Serializer, NTripleParser, NTripleSerializer, RdfParser, RdfParser.N3, RdfParser.NTriple, RdfParser.Turtle, RdfParser.Xml, RdfSerializer, RdfSerializer.N3, RdfSerializer.NTriple, RdfSerializer.Turtle, RdfSerializer.Xml, RdfSerializer.XmlAbbrev, RdfXmlAbbrevSerializer, RdfXmlParser, RdfXmlSerializer, TurtleParser, TurtleSerializer

public interface RdfCommon

Configurable properties common to both the RdfSerializer and RdfParser classes.

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,String>	LANG_PROP_MAP Maps RDF writer names to property prefixes that apply to them.
static String	PREFIX Property prefix.
static String	RDF_arp_embedding Configuration property: RDF/XML ARP property: embedding.
static String	RDF_arp_err_ Configuration property: RDF/XML ARP property: ERR_xxx.
static String	RDF_arp_errorMode Configuration property: RDF/XML ARP property: error-mode.
static String	RDF_arp_ign_ RDF/XML ARP property: IGN_xxx.
static String	RDF_arp_iriRules Configuration property: RDF/XML property: iri_rules.
static String	RDF_arp_warn_ Configuration property: RDF/XML ARP property: WARN_xxx.
static String	RDF_collectionFormat Configuration property: RDF format for representing collections and arrays.
static String	RDF_juneauBpNs Configuration property: Default XML namespace for bean properties.
static String	RDF_juneauNs Configuration property: XML namespace for Juneau properties.
static String	RDF_language Configuration property: RDF language.
static String	RDF_looseCollections Configuration property: Collections should be serialized and parsed as loose collections.
static String	RDF_n3_abbrevBaseUri Configuration property: N3/Turtle property: abbrevBaseURI.
static String	RDF_n3_indentProperty Configuration property: N3/Turtle property: indentProperty.
static String	RDF_n3_minGap Configuration property: N3/Turtle property: minGap.
static String	RDF_n3_objectLists Configuration property: N3/Turtle property: objectLists.
static String	RDF_n3_propertyColumn Configuration property: N3/Turtle property: propertyColumn.
static String	RDF_n3_subjectColumn Configuration property: N3/Turtle property: subjectColumn.
static String	RDF_n3_useDoubles Configuration property: N3/Turtle property: useDoubles.
static String	RDF_n3_usePropertySymbols Configuration property: N3/Turtle property: usePropertySymbols.
static String	RDF_n3_useTripleQuotedStrings Configuration property: N3/Turtle property: useTripleQuotedStrings.
static String	RDF_n3_widePropertyLen Configuration property: N3/Turtle property: widePropertyLen.
static String	RDF_rdfxml_allowBadUris Configuration property: RDF/XML property: allowBadURIs.
static String	RDF_rdfxml_attributeQuoteChar Configuration property: RDF/XML property: attributeQuoteChar.
static String	RDF_rdfxml_blockRules Configuration property: RDF/XML property: blockRules.
static String	RDF_rdfxml_longId Configuration property: RDF/XML property: longId.
static String	RDF_rdfxml_relativeUris Configuration property: RDF/XML property: relativeURIs.
static String	RDF_rdfxml_showDoctypeDeclaration Configuration property: RDF/XML property: showDoctypeDeclaration.
static String	RDF_rdfxml_showXmlDeclaration Configuration property: RDF/XML property: showXmlDeclaration.
static String	RDF_rdfxml_tab Configuration property: RDF/XML property: tab.
static String	RDF_rdfxml_xmlBase Configuration property: RDF/XML property: xmlbase.
static String	RDF_useXmlNamespaces Configuration property: Reuse XML namespaces when RDF namespaces not specified.

Field Detail

PREFIX

static final String PREFIX

Property prefix.

See Also:

Constant Field Values

LANG_PROP_MAP

static final Map<String,String> LANG_PROP_MAP

Maps RDF writer names to property prefixes that apply to them.

RDF_language

static final String RDF_language

Configuration property: RDF language.

Property:

• Name: "Rdf.language.s"
• Data type: String
• Default: "RDF/XML-ABBREV"
• Methods:
  • RdfSerializerBuilder.language(String)
  • RdfSerializerBuilder.n3()
  • RdfSerializerBuilder.ntriple()
  • RdfSerializerBuilder.turtle()
  • RdfSerializerBuilder.xml()
  • RdfSerializerBuilder.xmlabbrev()
  • RdfParserBuilder.language(String)
  • RdfParserBuilder.n3()
  • RdfParserBuilder.ntriple()
  • RdfParserBuilder.turtle()
  • RdfParserBuilder.xml()

Description:

The RDF language to use.

Can be any of the following:

• "RDF/XML"
• "RDF/XML-ABBREV" (default)
• "N-TRIPLE"
• "N3" - General name for the N3 writer. Will make a decision on exactly which writer to use (pretty writer, plain writer or simple writer) when created. Default is the pretty writer but can be overridden with system property com.hp.hpl.jena.n3.N3JenaWriter.writer.
• "N3-PP" - Name of the N3 pretty writer. The pretty writer uses a frame-like layout, with prefixing, clustering like properties and embedding one-referenced bNodes.
• "N3-PLAIN" - Name of the N3 plain writer. The plain writer writes records by subject.
• "N3-TRIPLES" - Name of the N3 triples writer. This writer writes one line per statement, like N-Triples, but does N3-style prefixing.
• "TURTLE" - Turtle writer. http://www.dajobe.org/2004/01/turtle/

See Also:

Constant Field Values

RDF_juneauNs

static final String RDF_juneauNs

Configuration property: XML namespace for Juneau properties.

Property:

• Name: "Rdf.juneauNs.s"
• Data type: Namespace
• Default: {j:'http://www.apache.org/juneau/'}
• Methods:
  • RdfSerializerBuilder.juneauNs(Namespace)
  • RdfParserBuilder.juneauNs(Namespace)

See Also:

Constant Field Values

RDF_juneauBpNs

static final String RDF_juneauBpNs

Configuration property: Default XML namespace for bean properties.

Property:

• Name: "Rdf.juneauBpNs.s"
• Data type: Namespace
• Default: {j:'http://www.apache.org/juneaubp/'}
• Methods:
  • RdfSerializerBuilder.juneauBpNs(Namespace)
  • RdfParserBuilder.juneauBpNs(Namespace)

See Also:

Constant Field Values

RDF_useXmlNamespaces

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)
  • RdfParserBuilder.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

RDF_arp_iriRules

static final String RDF_arp_iriRules

Configuration property: RDF/XML property: iri_rules.

Property:

• Name: "Rdf.jena.rdfXml.iri-rules.s"
• Data type: String
• Default: "lax"

Description:

Set the engine for checking and resolving.

Possible values:

• "lax" - The rules for RDF URI references only, which does permit spaces although the use of spaces is not good practice.
• "strict" - Sets the IRI engine with rules for valid IRIs, XLink and RDF; it does not permit spaces in IRIs.
• "iri" - Sets the IRI engine to IRI (RFC 3986, RFC 3987).

See Also:

Constant Field Values

RDF_arp_errorMode

static final String RDF_arp_errorMode

Configuration property: RDF/XML ARP property: error-mode.

Property:

• Name: "Rdf.jena.rdfXml.error-mode.s"
• Data type: String
• Default: "lax"

Description:

This allows a coarse-grained approach to control of error handling.

Possible values:

• "default"
• "lax"
• "strict"
• "strict-ignore"
• "strict-warning"
• "strict-error"
• "strict-fatal"

See also:

• ARPOptions.setDefaultErrorMode()
• ARPOptions.setLaxErrorMode()
• ARPOptions.setStrictErrorMode()
• ARPOptions.setStrictErrorMode(int)

See Also:

Constant Field Values

RDF_arp_embedding

static final String RDF_arp_embedding

Configuration property: RDF/XML ARP property: embedding.

Property:

• Name: "Rdf.jena.rdfXml.embedding.b"
• Data type: Boolean
• Default: false

Description:

Sets ARP to look for RDF embedded within an enclosing XML document.

See also:

• ARPOptions.setEmbedding(boolean)

See Also:

Constant Field Values

RDF_arp_err_

static final String RDF_arp_err_

Configuration property: RDF/XML ARP property: ERR_xxx.

Property:

• Name: "Rdf.jena.rdfXml.ERR_"
• Data type: String

Description:

Provides fine-grained control over detected error conditions.

Possible values:

• "EM_IGNORE"
• "EM_WARNING"
• "EM_ERROR"
• "EM_FATAL"

See also:

• ARPErrorNumbers
• ARPOptions.setErrorMode(int, int)

See Also:

Constant Field Values

RDF_arp_warn_

static final String RDF_arp_warn_

Configuration property: RDF/XML ARP property: WARN_xxx.

Property:

• Name: "Rdf.jena.rdfXml.WARN_"
• Data type: String

Description:

See RDF_arp_err_ for details.

See Also:

Constant Field Values

RDF_arp_ign_

static final String RDF_arp_ign_

RDF/XML ARP property: IGN_xxx.

Property:

• Name: "Rdf.jena.rdfXml.IGN_"
• Data type: String

Description:

See RDF_arp_err_ for details.

See Also:

Constant Field Values

RDF_rdfxml_xmlBase

static final String RDF_rdfxml_xmlBase

Configuration property: RDF/XML property: xmlbase.

Property:

• Name: "Rdf.jena.rdfXml.xmlbase.s"
• Data type: String
• Default: null

Description:

The value to be included for an xml:base attribute on the root element in the file.

See Also:

Constant Field Values

RDF_rdfxml_longId

static final String RDF_rdfxml_longId

Configuration property: RDF/XML property: longId.

Property:

• Name: "Rdf.jena.rdfXml.longId.b"
• Data type: Boolean
• Default: false

Description:

Whether to use long ID's for anon resources. Short ID's are easier to read, but can run out of memory on very large models.

See Also:

Constant Field Values

RDF_rdfxml_allowBadUris

static final String RDF_rdfxml_allowBadUris

Configuration property: RDF/XML property: allowBadURIs.

Property:

• Name: "Rdf.jena.rdfXml.allowBadURIs.b"
• Data type: Boolean
• Default: false

Description:

URIs in the graph are, by default, checked prior to serialization.

See Also:

Constant Field Values

RDF_rdfxml_relativeUris

static final String RDF_rdfxml_relativeUris

Configuration property: RDF/XML property: relativeURIs.

Property:

• Name: "Rdf.jena.rdfXml.relativeURIs.s"
• Data type: String
• Default: "same-document, absolute, relative, parent"

Description:

What sort of relative URIs should be used.

A comma separate list of options:

• "same-document" - Same-document references (e.g. "" or "#foo")
• "network" - Network paths (e.g. "//example.org/foo" omitting the URI scheme)
• "absolute" - Absolute paths (e.g. "/foo" omitting the scheme and authority)
• "relative" - Relative path not beginning in "../"
• "parent" - Relative path beginning in "../"
• "grandparent" - Relative path beginning in "../../"

The default value is "same-document, absolute, relative, parent". To switch off relative URIs use the value "". Relative URIs of any of these types are output where possible if and only if the option has been specified.

See Also:

Constant Field Values

RDF_rdfxml_showXmlDeclaration

static final String RDF_rdfxml_showXmlDeclaration

Configuration property: RDF/XML property: showXmlDeclaration.

Property:

• Name: "Rdf.jena.rdfXml.showXmlDeclaration.s"
• Data type: String
• Default: "default"

Description:

Possible values:

• "true" - Add XML Declaration to the output.
• "false" - Don't add XML Declaration to the output.
• "default" - Only add an XML Declaration when asked to write to an OutputStreamWriter that uses some encoding other than UTF-8 or UTF-16. In this case the encoding is shown in the XML declaration.

See Also:

Constant Field Values

RDF_rdfxml_showDoctypeDeclaration

static final String RDF_rdfxml_showDoctypeDeclaration

Configuration property: RDF/XML property: showDoctypeDeclaration.

Property:

• Name: "Rdf.jena.rdfXml.showDoctypeDeclaration.b"
• Data type: Boolean
• Default: true

Description:

If true, an XML doctype declaration is included in the output. This declaration includes a !ENTITY declaration for each prefix mapping in the model, and any attribute value that starts with the URI of that mapping is written as starting with the corresponding entity invocation.

See Also:

Constant Field Values

RDF_rdfxml_tab

static final String RDF_rdfxml_tab

Configuration property: RDF/XML property: tab.

Property:

• Name: "Rdf.jena.rdfXml.tab.i"
• Data type: Integer
• Default: 2

Description:

The number of spaces with which to indent XML child elements.

See Also:

Constant Field Values

RDF_rdfxml_attributeQuoteChar

static final String RDF_rdfxml_attributeQuoteChar

Configuration property: RDF/XML property: attributeQuoteChar.

Property:

• Name: "Rdf.jena.rdfXml.attributeQuoteChar.s"
• Data type: Character
• Default: '"'

Description:

The XML attribute quote character.

See Also:

Constant Field Values

RDF_rdfxml_blockRules

static final String RDF_rdfxml_blockRules

Configuration property: RDF/XML property: blockRules.

Property:

• Name: "Rdf.jena.rdfXml.blockRules.s"
• Data type: String
• Default: ""

Description:

A list of Resource or a String being a comma separated list of fragment IDs from RDF Syntax Grammar indicating grammar rules that will not be used.

See Also:

Constant Field Values

RDF_n3_minGap

static final String RDF_n3_minGap

Configuration property: N3/Turtle property: minGap.

Property:

• Name: "Rdf.jena.n3.minGap.i"
• Data type: Integer
• Default: 1

Description:

Minimum gap between items on a line.

See Also:

Constant Field Values

RDF_n3_objectLists

static final String RDF_n3_objectLists

Configuration property: N3/Turtle property: objectLists.

Property:

• Name: "Rdf.jena.n3.objectLists.b"
• Data type: Boolean
• Default: true

Description:

Print object lists as comma separated lists.

See Also:

Constant Field Values

RDF_n3_subjectColumn

static final String RDF_n3_subjectColumn

Configuration property: N3/Turtle property: subjectColumn.

Property:

• Name: "Rdf.jena.n3.subjectColumn.i"
• Data type: Integer
• Default: indentProperty

Description:

If the subject is shorter than this value, the first property may go on the same line.

See Also:

Constant Field Values

RDF_n3_propertyColumn

static final String RDF_n3_propertyColumn

Configuration property: N3/Turtle property: propertyColumn.

Property:

• Name: "Rdf.jena.n3.propertyColumn.i"
• Data type: Integer
• Default: 8

Description:

Width of the property column.

See Also:

Constant Field Values

RDF_n3_indentProperty

static final String RDF_n3_indentProperty

Configuration property: N3/Turtle property: indentProperty.

Property:

• Name: "Rdf.jena.n3.indentProperty.i"
• Data type: Integer
• Default: 6

Description:

Width to indent properties.

See Also:

Constant Field Values

RDF_n3_widePropertyLen

static final String RDF_n3_widePropertyLen

Configuration property: N3/Turtle property: widePropertyLen.

Property:

• Name: "Rdf.jena.n3.widePropertyLen.i"
• Data type: Integer
• Default: 20

Description:

Width of the property column. Must be longer than propertyColumn.

See Also:

Constant Field Values

RDF_n3_abbrevBaseUri

static final String RDF_n3_abbrevBaseUri

Configuration property: N3/Turtle property: abbrevBaseURI.

Property:

• Name: "Rdf.jena.n3.abbrevBaseURI.b"
• Data type: Boolean
• Default: true

Description:

Control whether to use abbreviations <> or <#>.

See Also:

Constant Field Values

RDF_n3_usePropertySymbols

static final String RDF_n3_usePropertySymbols

Configuration property: N3/Turtle property: usePropertySymbols.

Property:

• Name: "Rdf.jena.n3.usePropertySymbols.b"
• Data type: Boolean
• Default: true

Description:

Control whether to use a, = and => in output

See Also:

Constant Field Values

RDF_n3_useTripleQuotedStrings

static final String RDF_n3_useTripleQuotedStrings

Configuration property: N3/Turtle property: useTripleQuotedStrings.

Property:

• Name: "Rdf.jena.n3.useTripleQuotedStrings.b"
• Data type: Boolean
• Default: true

Description:

Allow the use of """ to delimit long strings.

See Also:

Constant Field Values

RDF_n3_useDoubles

static final String RDF_n3_useDoubles

Configuration property: N3/Turtle property: useDoubles.

Property:

• Name: "Rdf.jena.n3.useDoubles.b"
• Data type: Boolean
• Default: true

Description:

Allow the use doubles as 123.456.

See Also:

Constant Field Values

RDF_collectionFormat

static final String RDF_collectionFormat

Configuration property: RDF format for representing collections and arrays.

Property:

• Name: "Rdf.collectionFormat.s"
• Data type: String
• Default: "DEFAULT"
• Methods:
  • RdfSerializerBuilder.collectionFormat(RdfCollectionFormat)
  • RdfParserBuilder.collectionFormat(RdfCollectionFormat)

Description:

Possible values:

• "DEFAULT" - Default format. The default is an RDF Sequence container.
• "SEQ" - RDF Sequence container.
• "BAG" - RDF Bag container.
• "LIST" - RDF List container.
• "MULTI_VALUED" - Multi-valued properties.

Notes:

• If you use "BAG" or "MULTI_VALUED", the order of the elements in the collection will get lost.

See Also:

Constant Field Values

RDF_looseCollections

static final String RDF_looseCollections

Configuration property: Collections should be serialized and parsed as loose collections.

Property:

• Name: "Rdf.looseCollections.b"
• Data type: Boolean
• Default: false
• Methods:
  • RdfSerializerBuilder.looseCollections(boolean)
  • RdfSerializerBuilder.looseCollections()
  • RdfParserBuilder.looseCollections(boolean)
  • RdfParserBuilder.looseCollections()

Description:

When specified, 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).

Note that this setting is specialized for RDF syntax, and is incompatible with the concept of losslessly representing POJO models, since the tree structure of these POJO models are lost when serialized as loose collections.

This setting is typically only useful if the beans being parsed into do not have a bean property annotated with @Rdf(beanUri=true).

Example:

WriterSerializer s = RdfSerializer.create().xmlabbrev().looseCollections(true).build(); ReaderParser p = RdfParser.create().xml().looseCollections(true).build(); List<MyBean> l = createListOfMyBeans(); // Serialize to RDF/XML as loose resources String rdfXml = s.serialize(l); // Parse back into a Java collection l = p.parse(rdfXml, LinkedList.class, MyBean.class); MyBean[] b = createArrayOfMyBeans(); // Serialize to RDF/XML as loose resources String rdfXml = s.serialize(b); // Parse back into a bean array b = p.parse(rdfXml, MyBean[].class);

See Also:

Constant Field Values