Swish.Utils.Namespace

This module defines algebraic datatypes for namespaces and scoped names.

For these purposes, a namespace is a prefix and URI used to identify a namespace (cf. XML namespaces), and a scoped name is a name that is scoped by a specified namespace.

Documentation

data Namespace

A NameSpace value consists of an optional prefix and a corresponding URI.

Instances

Eq Namespace

Equality is defined by the URI, not by the prefix (so the same URI with different prefixes will be considered to be equal).

Show Namespace

LookupEntryClass Namespace (Maybe Text) URI

LookupEntryClass (Ruleset ex) Namespace (Ruleset ex)

makeNamespace :: Maybe Text -> URI -> Namespace

makeNamespaceQName :: Namespace -> Text -> QName

getNamespacePrefix :: Namespace -> Maybe Text

getNamespaceURI :: Namespace -> URI

getNamespaceTuple :: Namespace -> (Maybe Text, URI)

data ScopedName

A full ScopedName value has a QName prefix, namespace URI and a local part. ScopedName values may omit the prefix (see Namespace) or the local part.

Some applications may handle null namespace URIs as meaning the local part is relative to some base URI.

Instances

Eq ScopedName

Ord ScopedName

Show ScopedName

IsString ScopedName

This is not total since it will fail if the input string is not a valid URI.

FromRDFLabel ScopedName

Converts from a Resource.

ToRDFLabel ScopedName

Converts to a Resource.

LookupEntryClass ClassRestriction ScopedName ClassRestriction

LookupEntryClass NamedGraph ScopedName [RDFGraph]

LookupEntryClass (Rule ex) ScopedName (Rule ex)

LookupEntryClass (Formula ex) ScopedName (Formula ex)

LookupEntryClass (DatatypeRel vt) ScopedName (DatatypeRel vt)

LookupEntryClass (OpenVarBindingModify a b) ScopedName (OpenVarBindingModify a b)

Allow an OpenVarBindingModify value to be accessed using a LookupMap.

LookupEntryClass (VarBindingModify a b) ScopedName (VarBindingModify a b)

Allow a VarBindingModify value to be accessed using a LookupMap.

LookupEntryClass (DatatypeMod vt lb vn) ScopedName (DatatypeMod vt lb vn)

LookupEntryClass (Datatype ex lb vn) ScopedName (Datatype ex lb vn)

getScopeNamespace :: ScopedName -> Namespace

getScopeLocal :: ScopedName -> Text

getScopePrefix :: ScopedName -> Maybe Text

getScopeURI :: ScopedName -> URI

getQName :: ScopedName -> QName

Get QName corresponding to a scoped name

getScopedNameURI :: ScopedName -> URI

Get URI corresponding to a scoped name (using RDF conventions)

matchName :: String -> ScopedName -> Bool

Test if supplied string matches the display form of a scoped name.

makeScopedName :: Maybe Text -> URI -> Text -> ScopedName

Construct a ScopedName from prefix, URI and local name

makeQNameScopedName :: Maybe Text -> QName -> ScopedName

Construct a ScopedName from a QName

makeURIScopedName :: URI -> ScopedName

Construct a ScopedName for a bare URI (the label is set to "").

makeNSScopedName :: Namespace -> Text -> ScopedName

Construct a ScopedName from a Namespace and local component

nullScopedName :: ScopedName

This should never appear as a valid name

namespaceToBuilder :: Namespace -> Builder

Utility routine to create a @prefix line (matching N3/Turtle) grammar for this namespace.