eu.fbk.rdfpro.util

Class Namespaces

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<org.openrdf.model.Namespace>

eu.fbk.rdfpro.util.Namespaces

All Implemented Interfaces:

Iterable<org.openrdf.model.Namespace>, Collection<org.openrdf.model.Namespace>, Set<org.openrdf.model.Namespace>

public final class Namespaces
extends AbstractSet<org.openrdf.model.Namespace>

A specialized immutable Namespace set.

A Namespaces object is an immutable container of prefix -> namespace URI bindings, where multiple prefixes can map to the same namespace URI but there is at most a binding for any given prefix.

Data in this class can be primarily accessed using lookup methods uriFor(String), prefixFor(String) and prefixesFor(String). In addition, the following views are offered:

• set<Namespace object> view, directly implemented by class instances;
• prefix -> namespace URI map view, produced by uriMap;
• namespace URI -> prefix map view, produced by prefixMap();
• set<prefix string> view, produced by prefixes();
• set<URI string> view, produced by uris();

Instances of this class can be created from:

• a Namespace iterable, by forIterable(Iterable, boolean);
• a prefix -> namespace URI map, by forURIMap(Map);
• a namespace URI -> prefix map, by forPrefixMap(Map, boolean);
• a list of files identified by URLs, by load(Iterable, boolean);

This class is immutable and thus thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
static Namespaces	DEFAULT

Method Summary

Modifier and Type	Method and Description
boolean	contains(Object object)
static Namespaces	forIterable(Iterable<? extends org.openrdf.model.Namespace> iterable, boolean resolveClashes) Returns a Namespaces set for the Namespace Iterable supplied.
static Namespaces	forPrefixMap(Map<String,String> map, boolean resolveClashes) Returns a Namespaces set for the namespace URI -> prefix map supplied.
static Namespaces	forURIMap(Map<String,String> map) Returns a Namespaces set for the prefix -> namespace URI map supplied.
boolean	isEmpty()
Iterator<org.openrdf.model.Namespace>	iterator()
static Namespaces	load(Iterable<URL> urls, boolean resolveClashes) Creates a Namespaces set by loading the namespace declarations in the files at the URLs specified.
Set<String>	prefixes() Returns a Set view of the prefixes in this Namespace set.
List<String>	prefixesFor(String uri) Returns all the prefixes bound to the namespace URI specified.
String	prefixFor(String uri) Returns the first prefix bound to the namespace URI specified, or null if it does not exist.
Map<String,String>	prefixMap() Returns a namespace URI -> prefix map view.
int	size()
org.openrdf.model.Namespace[]	toArray()
String	uriFor(String prefix) Returns the namespace URI for the prefix specified, or null if it does not exist.
Map<String,String>	uriMap() Returns a prefix -> namespace URI map view.
Set<String>	uris() Returns a Set view of the namespace URIs in this Namespace set.

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

add, addAll, clear, containsAll, remove, retainAll, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

add, addAll, clear, containsAll, remove, retainAll, spliterator, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

DEFAULT

public static final Namespaces DEFAULT

Method Detail

load

public static Namespaces load(Iterable<URL> urls,
                              boolean resolveClashes)
                       throws IOException

Creates a Namespaces set by loading the namespace declarations in the files at the URLs specified. The text files must be encoded in UTF-8. Each line has the format namespace_URI prefix_1 ... prefix_N, where components are separated by whitespaces.

Parameters:

urls - the URLs identifying the files to load, not null

resolveClashes - true in case a clash caused by the same prefix being mapped to different namespace URIs should be silently resolved by keeping only the first mapping in the supplied iterable

Returns:

the created Namespaces object

Throws:

IOException - on IO error

IllegalArgumentException - in case resolveClashes is false and the Iterable associates the same prefix to different namespace URIs

forIterable

public static Namespaces forIterable(Iterable<? extends org.openrdf.model.Namespace> iterable,
                                     boolean resolveClashes)
                              throws IllegalArgumentException

Returns a Namespaces set for the Namespace Iterable supplied. In case the Iterable is itself a Namespaces object, it will be directly returned.

Parameters:

iterable - the Iterable where to load namespaces from, not null

resolveClashes - true in case a clash caused by the same prefix being mapped to different namespace URIs should be silently resolved by keeping only the first mapping in the supplied iterable

Returns:

the corresponding Namespaces object

Throws:

IllegalArgumentException - in case resolveClashes is false and the Iterable associates the same prefix to different namespace URIs

forURIMap

public static Namespaces forURIMap(Map<String,String> map)

Returns a Namespaces set for the prefix -> namespace URI map supplied. In case the map is the uriMap() of another Namespaces object, that object will be directly returned.

Parameters:

map - the prefix -> namespace URI map, not null

Returns:

the corresponding Namespaces object

forPrefixMap

public static Namespaces forPrefixMap(Map<String,String> map,
                                      boolean resolveClashes)
                               throws IllegalArgumentException

Returns a Namespaces set for the namespace URI -> prefix map supplied. In case the map is the prefixMap() of another Namespaces object, that object will be directly returned.

Parameters:

map - the namespace URI -> prefix map, not null

resolveClashes - true in case a clash caused by the same prefix being mapped to different namespace URIs should be silently resolved by keeping only the first mapping in the supplied iterable

Returns:

the corresponding Namespaces object

Throws:

IllegalArgumentException - in case resolveClashes is false and the Iterable associates the same prefix to different namespace URIs

size

public int size()

Specified by:

size in interface Collection<org.openrdf.model.Namespace>

Specified by:

size in interface Set<org.openrdf.model.Namespace>

Specified by:

size in class AbstractCollection<org.openrdf.model.Namespace>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<org.openrdf.model.Namespace>

Specified by:

isEmpty in interface Set<org.openrdf.model.Namespace>

Overrides:

isEmpty in class AbstractCollection<org.openrdf.model.Namespace>

contains

public boolean contains(@Nullable
                        Object object)

Specified by:

contains in interface Collection<org.openrdf.model.Namespace>

Specified by:

contains in interface Set<org.openrdf.model.Namespace>

Overrides:

contains in class AbstractCollection<org.openrdf.model.Namespace>

prefixes

public Set<String> prefixes()

Returns a Set view of the prefixes in this Namespace set.

Returns:

a Set view of prefixes

prefixesFor

public List<String> prefixesFor(String uri)

Returns all the prefixes bound to the namespace URI specified.

Parameters:

uri - the namespace URI, not null

Returns:

a non-null list with the prefixes bound to the give URI

prefixFor

@Nullable
public String prefixFor(String uri)

Returns the first prefix bound to the namespace URI specified, or null if it does not exist.

Parameters:

uri - the namespace URI, not null

Returns:

the first prefix bound to the namespace URI specified, if it exists, otherwise null

prefixMap

public Map<String,String> prefixMap()

Returns a namespace URI -> prefix map view. Note that the map will report only the first prefix bound to a namespace URI, in case multiple prefixes are defined for that URI.

Returns:

a namespace URI -> prefix map view

uris

public Set<String> uris()

Returns a Set view of the namespace URIs in this Namespace set.

Returns:

a Set view of namespace URIs

uriFor

@Nullable
public String uriFor(String prefix)

Returns the namespace URI for the prefix specified, or null if it does not exist.

Parameters:

prefix - the prefix, not null

Returns:

the namespace URI for the prefix specified, if it exists, otherwise null

uriMap

public Map<String,String> uriMap()

Returns a prefix -> namespace URI map view.

Returns:

a prefix -> namespace URI map view

iterator

public Iterator<org.openrdf.model.Namespace> iterator()

Specified by:

iterator in interface Iterable<org.openrdf.model.Namespace>

Specified by:

iterator in interface Collection<org.openrdf.model.Namespace>

Specified by:

iterator in interface Set<org.openrdf.model.Namespace>

Specified by:

iterator in class AbstractCollection<org.openrdf.model.Namespace>

toArray

public org.openrdf.model.Namespace[] toArray()

Specified by:

toArray in interface Collection<org.openrdf.model.Namespace>

Specified by:

toArray in interface Set<org.openrdf.model.Namespace>

Overrides:

toArray in class AbstractCollection<org.openrdf.model.Namespace>