Package dev.enola.thing

Interface PredicatesObjects

All Known Subinterfaces:

Bookmark, Class, Class, Class.Builder<B>, Common, Common.Builder<B>, CreativeWork, Datatype, Datatype.Builder<B>, Enum, Enumeration, EnumValue, HasA, HasB, HasChildren, HasClass, HasComment, HasDescription, HasDirection, HasFileExtensions, HasIcon, HasLabel, HasLanguage, HasMediaType, HasName, HasName.Builder<B>, HasParent, HasSeeAlso, HasType, HasURL, IImmutablePredicatesObjects, IImmutableThing, MediaType, Package, Property, Property, Property.Builder<B>, Resource, Schema, Schema.Builder<B>, Speciality, Subject, Tag, TestSomething, Thing, Thing, ThingOrBuilder<B>, Type, Type, Type.Builder<B>, UnknownClass, WebPage

All Known Implementing Classes:

DatatypeThing, ImmutablePredicatesObjects, ImmutableThing, MutablePredicatesObjects, MutableThing, OnlyIRIThing, PredicatesObjectsAdapter, ThingAdapter

public interface PredicatesObjects

PredicatesObjects is a "struct" of Predicates and their Objects.

Contrary to a Thing, this has no "identity" and thus no IRI. RDF calls this a "Blank Node". This is informally often also referred to as a Things's Properties - it's just the Thing without its identifying IRI.

It is typically used for objects "contained inside" Things (or their nested sub-structs).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PredicatesObjects.Builder<B extends PredicatesObjects>

Method Summary

Modifier and Type	Method	Description
PredicatesObjects.Builder<? extends PredicatesObjects>	copy()
default @Nullable String	datatype(HasPredicateIRI predicateIRI)
@Nullable String	datatype(String predicateIRI)	IRI of datatype of predicate, if any (else null).
Map<String,String>	datatypes()	Deprecated.
default <T> @Nullable T	get(HasPredicateIRI predicate, Class<T> klass)	Deprecated.
<T> @Nullable T	get(String predicateIRI)	Deprecated. Use get(String, Class) instead.
default <T> @Nullable T	get(String predicateIRI, TypeToken<T> typeToken)
default <T> @Nullable T	get(String predicateIRI, Class<T> klass)	Deprecated.
default Collection<Object>	getLinks(String predicateIRI)	Links, for predicate.
default <T> Optional<T>	getOptional(String predicateIRI, Class<T> klass)	Object of predicate, with type conversion - as Optional.
default @Nullable String	getString(HasPredicateIRI predicate)
default @Nullable String	getString(String predicateIRI)
default <T extends Thing> Optional<T>	getThing(String predicateIRI, Class<T> klass)	Deprecated.
default <T extends Thing, B extends Thing.Builder<T>> Optional<T>	getThing(String predicateIRI, Class<T> klass, Class<B> builderClass)
default <T extends Thing> T	getThingOrThrow(String predicateIRI, Class<T> klass)	Deprecated.
default <T extends Thing> Iterable<T>	getThings(HasPredicateIRI predicate, Class<T> klass)
default Iterable<Thing>	getThings(String predicateIRI)
default <T extends Thing> Iterable<T>	getThings(String predicateIRI, Class<T> klass)	Deprecated.
default <T extends Thing, B extends Thing.Builder<T>> Iterable<T>	getThings(String predicateIRI, Class<T> klass, Class<B> builderClass)
default boolean	hasLink(String predicateIRI, String linkIRI)
default boolean	isIterable(String predicateIRI)
default boolean	isLinkObject(@Nullable Object object)
default boolean	isOrdered(String predicateIRI)
default boolean	isStruct(String predicateIRI)
Set<String>	predicateIRIs()	IRIs of the Predicates of this Thing.
Map<String,Object>	properties()	Deprecated.

Method Details

properties

@Deprecated
Map<String,Object> properties()

Deprecated.

The Map's key is the IRI of a predicate, and the value is as would be returned by get(String).

predicateIRIs

Set<String> predicateIRIs()

IRIs of the Predicates of this Thing.

isLinkObject

default boolean isLinkObject(@Nullable Object object)

isIterable

default boolean isIterable(String predicateIRI)

isOrdered

default boolean isOrdered(String predicateIRI)

isStruct

default boolean isStruct(String predicateIRI)

datatype

@Nullable String datatype(String predicateIRI)

IRI of datatype of predicate, if any (else null). Not all predicates will have a datatype set. This is required because the predicate's Object Java class is not necessarily unique; e.g. both dev.enola.model.schema.Datatypes.DATE as well as dev.enola.model.xsd.DATE are java.time.LocalDate instances.

datatype

default @Nullable String datatype(HasPredicateIRI predicateIRI)

datatypes

@Deprecated
Map<String,String> datatypes()

Deprecated.

get

@Deprecated
<T> @Nullable T get(String predicateIRI)

Deprecated.

Use get(String, Class) instead.

Object of predicate. The type is e.g. directly a String, Integer etc. Alternatively, it may be a Link (or URI) with an IRI or another PredicatesObjects (for an "inline embedded/expanded blank node") or a List of such items. The object is immutable. May be null if Thing has no such predicate.

get

@Deprecated
default <T> @Nullable T get(String predicateIRI,
 Class<T> klass)

Deprecated.

Object of predicate, with type conversion - or failure.

BEWARE: This may well fail and throw an IllegalArgumentException! You can never really be sure what Java type an object of a predicate is. If in doubt, use getOptional(String, Class), or perhaps get(String) with an ObjectClassConverter.

get

@Deprecated
default <T> @Nullable T get(HasPredicateIRI predicate,
 Class<T> klass)

Deprecated.

get

default <T> @Nullable T get(String predicateIRI,
 TypeToken<T> typeToken)

getOptional

default <T> Optional<T> getOptional(String predicateIRI,
 Class<T> klass)

Object of predicate, with type conversion - as Optional.

Returns:

property as type, if set

Throws:

IllegalStateException - if Datatype is not found, but needed

ConversionException - if known Datatype failed to convert

getString

default @Nullable String getString(String predicateIRI)

getString

default @Nullable String getString(HasPredicateIRI predicate)

getThing

@Deprecated
default <T extends Thing> Optional<T> getThing(String predicateIRI,
 Class<T> klass)

Deprecated.

getThingOrThrow

@Deprecated
default <T extends Thing> T getThingOrThrow(String predicateIRI,
 Class<T> klass)

Deprecated.

getThing

default <T extends Thing,
B extends Thing.Builder<T>>
Optional<T> getThing(String predicateIRI,
 Class<T> klass,
 Class<B> builderClass)

getThings

@Deprecated
default <T extends Thing> Iterable<T> getThings(String predicateIRI,
 Class<T> klass)

Deprecated.

getThings

default <T extends Thing,
B extends Thing.Builder<T>>
Iterable<T> getThings(String predicateIRI,
 Class<T> klass,
 Class<B> builderClass)

getThings

default Iterable<Thing> getThings(String predicateIRI)

getThings

default <T extends Thing> Iterable<T> getThings(HasPredicateIRI predicate,
 Class<T> klass)

getLinks

default Collection<Object> getLinks(String predicateIRI)

Links, for predicate.

This transparently correctly handles if said predicate is not a link, a single link, or an iterable of which some elements are links.

Returns:

iterable objects which are links. Never null, but may well be empty. The type of the contained elements can vary, and be either String, URI, Link; it's possible to use Object.toString() to get the IRI of the link, because Link.toString() is implemented as expected.

hasLink

default boolean hasLink(String predicateIRI,
 String linkIRI)

copy

PredicatesObjects.Builder<? extends PredicatesObjects> copy()