Module org.apache.jena.ontapi

Package org.apache.jena.ontapi.common

Class OntObjectPersonalityBuilder

java.lang.Object

org.apache.jena.ontapi.common.OntObjectPersonalityBuilder

public class OntObjectPersonalityBuilder
extends Object

An OntPersonality builder. This must be the only place to create various OntPersonality objects.

Constructor Summary

Constructors

Constructor	Description
OntObjectPersonalityBuilder()

Method Summary

Modifier and Type	Method	Description
OntObjectPersonalityBuilder	add(Class<? extends OntObject> type, Function<OntConfig,EnhNodeFactory> factory)	Associates the specified factory producer with the specified object type.
OntObjectPersonalityBuilder	add(Class<? extends OntObject> type, EnhNodeFactory factory)	Associates the specified factory with the specified object type.
OntObjectPersonalityBuilder	add(OntObjectPersonalityBuilder other)	Adds all factories from the specified builder.
OntObjectPersonalityBuilder	addPersonality(org.apache.jena.enhanced.Personality<org.apache.jena.rdf.model.RDFNode> from)	Adds everything from the specified Jena Personality to the existing internal collection.
OntPersonality	build()	Builds a new personality configuration.
OntObjectPersonalityBuilder	copy()	Makes a full copy of this builder.
static OntObjectPersonalityBuilder	from(OntPersonality from)	Makes a full copy of the given OntPersonality in the form of modifiable builder.
OntObjectPersonalityBuilder	remove(Class<? extends OntObject> type)	Removes object factory.
OntObjectPersonalityBuilder	setBuiltins(OntPersonality.Builtins builtins)	Sets a new builtins personality vocabulary.
OntObjectPersonalityBuilder	setConfig(OntConfig config)	Sets config, which controls OntModel behaviour.
OntObjectPersonalityBuilder	setName(String profileName)	Sets identifier of language profile ("OWL", "RDF").
OntObjectPersonalityBuilder	setPunnings(OntPersonality.Punnings punnings)	Sets a new punnings personality vocabulary.
OntObjectPersonalityBuilder	setReserved(OntPersonality.Reserved reserved)	Sets a new reserved personality vocabulary.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OntObjectPersonalityBuilder

public OntObjectPersonalityBuilder()

Method Details

from

public static OntObjectPersonalityBuilder from(OntPersonality from)

Makes a full copy of the given OntPersonality in the form of modifiable builder.

Parameters:

from - OntPersonality to copy settings, not null

Returns:

OntObjectPersonalityBuilder

copy

public OntObjectPersonalityBuilder copy()

Makes a full copy of this builder.

Returns:

OntObjectPersonalityBuilder, a copy

add

public OntObjectPersonalityBuilder add(OntObjectPersonalityBuilder other)

Adds all factories from the specified builder.

Parameters:

other - OntObjectPersonalityBuilder

Returns:

this builder

add

public OntObjectPersonalityBuilder add(Class<? extends OntObject> type,
 EnhNodeFactory factory)

Associates the specified factory with the specified object type. If the builder previously contained a mapping for the object type, the old factory is replaced by the specified factory.

Note: the factory must not explicitly refer to another factory, instead it may contain implicit references through OntEnhGraph.asPersonalityModel(EnhGraph) method. For example, if you need a check, that some node is an OWL-Class inside your factory, you can use OntEnhGraph.canAs(Class, Node, EnhGraph) with the type OntClass.Named.

Parameters:

type - Class-type of the concrete OntObject.

factory - EnhNodeFactory the factory to produce the instances of the type

Returns:

this builder

add

public OntObjectPersonalityBuilder add(Class<? extends OntObject> type,
 Function<OntConfig,EnhNodeFactory> factory)

Associates the specified factory producer with the specified object type. If the builder previously contained a mapping for the object type, the old factory is replaced by the specified factory.

Note: the factory must not explicitly refer to another factory, instead it may contain implicit references through OntEnhGraph.asPersonalityModel(EnhGraph) method. For example, if you need a check, that some node is an OWL-Class inside your factory, you can use OntEnhGraph.canAs(Class, Node, EnhGraph) with the type OntClass.Named.

Parameters:

type - Class-type of the concrete OntObject.

factory - Function, providing EnhNodeFactory by the OntConfig

Returns:

this builder

remove

public OntObjectPersonalityBuilder remove(Class<? extends OntObject> type)

Removes object factory.

Parameters:

type - Class-type of OntObject

Returns:

this builder

addPersonality

public OntObjectPersonalityBuilder addPersonality(org.apache.jena.enhanced.Personality<org.apache.jena.rdf.model.RDFNode> from)

Adds everything from the specified Jena Personality to the existing internal collection.

Parameters:

from - Personality with generic type RDFNode, not null

Returns:

this builder

See Also:

• Personality.add(Personality)

setName

public OntObjectPersonalityBuilder setName(String profileName)

Sets identifier of language profile ("OWL", "RDF").

Parameters:

profileName - String, can be null

Returns:

this builder

setPunnings

public OntObjectPersonalityBuilder setPunnings(OntPersonality.Punnings punnings)

Sets a new punnings personality vocabulary.

Parameters:

punnings - OntPersonality.Punnings, not null

Returns:

this builder

setBuiltins

public OntObjectPersonalityBuilder setBuiltins(OntPersonality.Builtins builtins)

Sets a new builtins personality vocabulary.

Parameters:

builtins - OntPersonality.Builtins, not null

Returns:

this builder

setReserved

public OntObjectPersonalityBuilder setReserved(OntPersonality.Reserved reserved)

Sets a new reserved personality vocabulary.

Parameters:

reserved - OntPersonality.Reserved, not null

Returns:

this builder

setConfig

public OntObjectPersonalityBuilder setConfig(OntConfig config)

Sets config, which controls OntModel behaviour.

Parameters:

config - OntConfig, not null

Returns:

this builder

build

public OntPersonality build()
                     throws IllegalStateException

Builds a new personality configuration.

Returns:

OntPersonality, fresh instance

Throws:

IllegalStateException - in case the builder does not contain require components