Class Formula

A formula, or store of RDF statements

Hierarchy (View Summary)

Node
- Formula
  - Store

Constructors

constructor

new Formula(
    statements?: Statement<
        SubjectType,
        PredicateType,
        ObjectType,
        GraphType,
    >[],
    constraints?: readonly any[],
    initBindings?: readonly any[],
    optional?: readonly any[],
    opts?: FormulaOpts,
): Formula
Initializes this formula
Parameters
- Optionalstatements: Statement<SubjectType, PredicateType, ObjectType, GraphType>[]
  Initial array of statements
- Optionalconstraints: readonly any[]
  initial array of constraints
- OptionalinitBindings: readonly any[]
  initial bindings used in Query
- Optionaloptional: readonly any[]
  optional
- Optionalopts: FormulaOpts
  - rdfFactory
    The rdf factory that should be used by the store
Returns Formula
Overrides Node.constructor
- Defined in node_modules/rdflib/lib/formula.d.ts:61

Properties

classOrder

classOrder: number

The class order for this node

constraints

constraints: readonly any[]

`Optional`fetcher

fetcher?: Fetcher

The accompanying fetcher instance.

Is set by the fetcher when initialized.

initBindings

initBindings: readonly any[]

isVar

isVar: number

ns

ns: (nsuri: string, factory?: RdfJsDataFactory) => (ln: string) => NamedNode

A namespace for the specified namespace's URI

Type declaration

- (nsuri: string, factory?: RdfJsDataFactory): (ln: string) => NamedNode
- Gets a namespace for the specified namespace's URI
  Parameters
  - nsuri: string
    The URI for the namespace
  - Optionalfactory: RdfJsDataFactory
    The factory for creating named nodes with
  Returns (ln: string) => NamedNode

Param: nsuri

The URI for the namespace

optional

optional: readonly any[]

rdfFactory

rdfFactory: any

The factory used to generate statements and terms

statements

statements: Statement<SubjectType, PredicateType, ObjectType, GraphType>[]

termType

termType: "Graph"

The type of node

value

value: string

The node's value

`Static`fromValue

fromValue: <T extends FromValueReturns>(value: ValueType) => T

`Static`toJS

Methods

add

add(
    subject:
        | Quad_Subject
        | Quad<Quad_Subject, Quad_Predicate, Quad_Object, Quad_Graph>
        | Quad<Quad_Subject, Quad_Predicate, Quad_Object, Quad_Graph>[],
    predicate?: Quad_Predicate,
    object?: string | Term,
    graph?: Quad_Graph,
):
    | null
    | number
    | Formula
    | Statement<SubjectType, PredicateType, ObjectType, GraphType>
Add a statement from its parts
Parameters
- subject:
      | Quad_Subject
      | Quad<Quad_Subject, Quad_Predicate, Quad_Object, Quad_Graph>
      | Quad<Quad_Subject, Quad_Predicate, Quad_Object, Quad_Graph>[]
  the first part of the statement
- Optionalpredicate: Quad_Predicate
  the second part of the statement
- Optionalobject: string | Term
  the third part of the statement
- Optionalgraph: Quad_Graph
  the last part of the statement
Returns
    | null
    | number
    | Formula
    | Statement<SubjectType, PredicateType, ObjectType, GraphType>
- Defined in node_modules/rdflib/lib/formula.d.ts:68

addAll

addAll(
statements: Quad<Quad_Subject, Quad_Predicate, Quad_Object, Quad_Graph>[],
): void
Adds all the statements to this formula
Parameters
- statements: Quad<Quad_Subject, Quad_Predicate, Quad_Object, Quad_Graph>[]
  A collection of statements
Returns void
- Defined in node_modules/rdflib/lib/formula.d.ts:82

addStatement

addStatement(
    statement: Quad,
):
    | null
    | number
    | Formula
    | Statement<SubjectType, PredicateType, ObjectType, GraphType>
Add a statment object
Parameters
- statement: Quad
  An existing constructed statement to add
Returns
    | null
    | number
    | Formula
    | Statement<SubjectType, PredicateType, ObjectType, GraphType>
- Defined in node_modules/rdflib/lib/formula.d.ts:72

any

any(
    s?: null | Quad_Subject,
    p?: null | Quad_Predicate,
    o?: null | Quad_Object,
    g?: null | Quad_Graph,
): null | Node
Follow link from one node, using one wildcard, looking for one

For example, any(me, knows, null, profile) - a person I know accoring to my profile . any(me, knows, null, null) - a person I know accoring to anything in store . any(null, knows, me, null) - a person who know me accoring to anything in store .
Parameters
- Optionals: null | Quad_Subject
  A node to search for as subject, or if null, a wildcard
- Optionalp: null | Quad_Predicate
  A node to search for as predicate, or if null, a wildcard
- Optionalo: null | Quad_Object
  A node to search for as object, or if null, a wildcard
- Optionalg: null | Quad_Graph
  A node to search for as graph, or if null, a wildcard
Returns null | Node
A node which match the wildcard position, or null
- Defined in node_modules/rdflib/lib/formula.d.ts:95

anyJS

anyJS(
    s?: null | Quad_Subject,
    p?: null | Quad_Predicate,
    o?: null | Quad_Object,
    g?: null | Quad_Graph,
): any
Gets the first JavaScript object equivalent to a node based on the specified pattern
Parameters
- Optionals: null | Quad_Subject
  The subject
- Optionalp: null | Quad_Predicate
  The predicate
- Optionalo: null | Quad_Object
  The object
- Optionalg: null | Quad_Graph
  The graph that contains the statement
Returns any
- Defined in node_modules/rdflib/lib/formula.d.ts:111

anyStatementMatching

anyStatementMatching(
    s?: null | Quad_Subject,
    p?: null | Quad_Predicate,
    o?: null | Quad_Object,
    g?: null | Quad_Graph,
): undefined | Statement<SubjectType, PredicateType, ObjectType, GraphType>
Gets the first statement that matches the specified pattern
Parameters
- Optionals: null | Quad_Subject
- Optionalp: null | Quad_Predicate
- Optionalo: null | Quad_Object
- Optionalg: null | Quad_Graph
Returns undefined | Statement<SubjectType, PredicateType, ObjectType, GraphType>
- Defined in node_modules/rdflib/lib/formula.d.ts:115

anyValue

anyValue(
    s?: null | Quad_Subject,
    p?: null | Quad_Predicate,
    o?: null | Quad_Object,
    g?: null | Quad_Graph,
): string | void
Gets the value of a node that matches the specified pattern
Parameters
- Optionals: null | Quad_Subject
  The subject
- Optionalp: null | Quad_Predicate
  The predicate
- Optionalo: null | Quad_Object
  The object
- Optionalg: null | Quad_Graph
  The graph that contains the statement
Returns string | void
- Defined in node_modules/rdflib/lib/formula.d.ts:103

bnode

bnode(id?: string): BlankNode
Shortcut for adding blankNodes
Parameters
- Optionalid: string
Returns BlankNode
- Defined in node_modules/rdflib/lib/formula.d.ts:77

bottomTypeURIs

bottomTypeURIs(types: any): any
Finds the types in the list which have no stored subtypes These are a set of classes which provide by themselves complete information -- the other classes are redundant for those who know the class DAG.
Parameters
- types: any
  A map of the types
Returns any
- Defined in node_modules/rdflib/lib/formula.d.ts:141

collection

collection(): Collection
Creates a new collection

Returns Collection
- Defined in node_modules/rdflib/lib/formula.d.ts:143

compareTerm

compareTerm(other: Node): number
Compares this node with another
Parameters
- other: Node
  The other node
Returns number
See
to check if two nodes are equal
Inherited from Node.compareTerm
- Defined in node_modules/rdflib/lib/node-internal.d.ts:31

connectedStatements

connectedStatements(
    subject: Quad_Subject,
    doc: Quad_Graph,
    excludePredicateURIs?: readonly string[],
): Statement<SubjectType, PredicateType, ObjectType, GraphType>[]
Trace statements which connect directly, or through bnodes
Parameters
- subject: Quad_Subject
  The node to start looking for statments
- doc: Quad_Graph
  The document to be searched, or null to search all documents
- OptionalexcludePredicateURIs: readonly string[]
Returns Statement<SubjectType, PredicateType, ObjectType, GraphType>[]
an array of statements, duplicate statements are suppresssed.
- Defined in node_modules/rdflib/lib/formula.d.ts:232

each

each(
    s?: null | Quad_Subject,
    p?: null | Quad_Predicate,
    o?: null | Quad_Object,
    g?: null | Quad_Graph,
): Node[]
Follow links from one node, using one wildcard.

For example, each(me, knows, null, profile) - people I know accoring to my profile . each(me, knows, null, null) - people I know accoring to anything in store . each(null, knows, me, null) - people who know me accoring to anything in store .
Parameters
- Optionals: null | Quad_Subject
  A node to search for as subject, or if null, a wildcard
- Optionalp: null | Quad_Predicate
  A node to search for as predicate, or if null, a wildcard
- Optionalo: null | Quad_Object
  A node to search for as object, or if null, a wildcard
- Optionalg: null | Quad_Graph
  A node to search for as graph, or if null, a wildcard
Returns Node[]
- An array of nodes which match the wildcard position
- Defined in node_modules/rdflib/lib/formula.d.ts:156

equals

equals(other: Formula): boolean
Test whether this formula is equals to {other}
Parameters
- other: Formula
  The other formula
Returns boolean
Overrides Node.equals
- Defined in node_modules/rdflib/lib/formula.d.ts:161

findMembersNT

findMembersNT(thisClass: any): MembersMap
For thisClass or any subclass, anything which has it is its type or is the object of something which has the type as its range, or subject of something which has the type as its domain We don't bother doing subproperty (yet?)as it doesn't seeem to be used much. Get all the Classes of which we can RDFS-infer the subject is a member
Parameters
- thisClass: any
Returns MembersMap
a hash of URIs
- Defined in node_modules/rdflib/lib/formula.d.ts:171

findMemberURIs

findMemberURIs(subject: Node): UriMap
For thisClass or any subclass, anything which has it is its type or is the object of something which has the type as its range, or subject of something which has the type as its domain We don't bother doing subproperty (yet?)as it doesn't seeem to be used much. Get all the Classes of which we can RDFS-infer the subject is a member
Parameters
- subject: Node
  A named node
Returns UriMap
- Defined in node_modules/rdflib/lib/formula.d.ts:181

findSubClassesNT

findSubClassesNT(subject: Node): { [uri: string]: boolean }
Get all the Classes of which we can RDFS-infer the subject is a superclass Returns a hash table where key is NT of type and value is statement why we think so. Does NOT return terms, returns URI strings. We use NT representations in this version because they handle blank nodes.
Parameters
- subject: Node
Returns { [uri: string]: boolean }
- Defined in node_modules/rdflib/lib/formula.d.ts:189

findSuperClassesNT

findSuperClassesNT(subject: Node): { [uri: string]: boolean }
Get all the Classes of which we can RDFS-infer the subject is a subclass
Parameters
- subject: Node
  The thing whose classes are to be found
Returns { [uri: string]: boolean }
a hash table where key is NT of type and value is statement why we think so. Does NOT return terms, returns URI strings. We use NT representations in this version because they handle blank nodes.
- Defined in node_modules/rdflib/lib/formula.d.ts:200

findTypesNT

findTypesNT(subject: any): { [uri: string]: boolean }
Get all the Classes of which we can RDFS-infer the subject is a member todo: This will loop is there is a class subclass loop (Sublass loops are not illegal)
Parameters
- subject: any
  The thing whose classes are to be found
Returns { [uri: string]: boolean }
a hash table where key is NT of type and value is statement why we think so. Does NOT return terms, returns URI strings. We use NT representations in this version because they handle blank nodes.
- Defined in node_modules/rdflib/lib/formula.d.ts:212

findTypeURIs

findTypeURIs(subject: Quad_Subject): UriMap
Get all the Classes of which we can RDFS-infer the subject is a member todo: This will loop is there is a class subclass loop (Sublass loops are not illegal) Returns a hash table where key is NT of type and value is statement why we think so. Does NOT return terms, returns URI strings. We use NT representations in this version because they handle blank nodes.
Parameters
- subject: Quad_Subject
  A subject node
Returns UriMap
- Defined in node_modules/rdflib/lib/formula.d.ts:225

formula

formula(_features?: readonly string[]): Formula
Creates a new empty formula
Parameters
- Optional_features: readonly string[]
  Not applicable, but necessary for typing to pass
Returns Formula
- Defined in node_modules/rdflib/lib/formula.d.ts:238

fromNT

fromNT(str: any): any
Transforms an NTriples string format into a Node. The blank node bit should not be used on program-external values; designed for internal work such as storing a blank node id in an HTML attribute. This will only parse the strings generated by the various toNT() methods.
Parameters
- str: any
Returns any
- Defined in node_modules/rdflib/lib/formula.d.ts:245

hashString

hashString(): string
Creates a hash for this node

Returns string
Deprecated
use {rdfFactory.id} instead if possible
Inherited from Node.hashString
- Defined in node_modules/rdflib/lib/node-internal.d.ts:41

holds

holds(s: any, p?: any, o?: any, g?: any): boolean
Returns true if this formula holds the specified statement(s)
Parameters
- s: any
- Optionalp: any
- Optionalo: any
- Optionalg: any
Returns boolean
- Defined in node_modules/rdflib/lib/formula.d.ts:247

holdsStatement

holdsStatement(statement: any): boolean
Returns true if this formula holds the specified {statement}
Parameters
- statement: any
Returns boolean
- Defined in node_modules/rdflib/lib/formula.d.ts:251

id

id(term: TFIDFactoryTypes): Indexable
Returns a unique index-safe identifier for the given term.

Falls back to the rdflib hashString implementation if the given factory doesn't support id.
Parameters
- term: TFIDFactoryTypes
Returns Indexable
- Defined in node_modules/rdflib/lib/formula.d.ts:121

list

list(values: any, context: any): any
Used by the n3parser to generate list elements
Parameters
- values: any
  The values of the collection
- context: any
  The store
Returns any
- The term for the statement
- Defined in node_modules/rdflib/lib/formula.d.ts:258

NTtoURI

NTtoURI(t: any): {}
Transform a collection of NTriple URIs into their URI strings
Parameters
- t: any
  Some iterable collection of NTriple URI strings
Returns {}
A collection of the URIs as strings todo: explain why it is important to go through NT
- Defined in node_modules/rdflib/lib/formula.d.ts:265

sameTerm

sameTerm(other: Node): boolean
Compares whether this node is the same as the other one
Parameters
- other: Node
  Another node
Returns boolean
Inherited from Node.sameTerm
- Defined in node_modules/rdflib/lib/node-internal.d.ts:46

serialize

serialize(
    base: any,
    contentType: any,
    provenance: any,
    options?: any,
): undefined | string
Serializes this formula
Parameters
- base: any
  The base string
- contentType: any
  The content type of the syntax to use
- provenance: any
  The provenance URI
- Optionaloptions: any
  options to pass to the serializer, as defined in serialize method
Returns undefined | string
- Defined in node_modules/rdflib/lib/formula.d.ts:273

statementsMatching

statementsMatching<JustOne extends boolean = false>(
    s?: null | Quad_Subject,
    p?: null | Quad_Predicate,
    o?: null | Quad_Object,
    g?: null | Quad_Graph,
    justOne?: boolean,
): Statement<SubjectType, PredicateType, ObjectType, GraphType>[]
Search the Store This is really a teaching method as to do this properly you would use IndexedFormula
Type Parameters
- JustOne extends boolean = false
Parameters
- Optionals: null | Quad_Subject
  A node to search for as subject, or if null, a wildcard
- Optionalp: null | Quad_Predicate
  A node to search for as predicate, or if null, a wildcard
- Optionalo: null | Quad_Object
  A node to search for as object, or if null, a wildcard
- Optionalg: null | Quad_Graph
  A node to search for as graph, or if null, a wildcard
- OptionaljustOne: boolean
  flag - stop when found one rather than get all of them?
Returns Statement<SubjectType, PredicateType, ObjectType, GraphType>[]
- An array of nodes which match the wildcard position
- Defined in node_modules/rdflib/lib/formula.d.ts:133

substitute

substitute<T extends Node = Formula>(bindings: Bindings): T
Creates a new formula with the substituting bindings applied
Type Parameters
- T extends Node = Formula
Parameters
- bindings: Bindings
  The bindings to substitute
Returns T
Overrides Node.substitute
- Defined in node_modules/rdflib/lib/formula.d.ts:278

sym

sym(uri: string, name?: any): NamedNode
Parameters
- uri: string
- Optionalname: any
Returns NamedNode
- Defined in node_modules/rdflib/lib/formula.d.ts:279

the

the(
    s?: null | Quad_Subject,
    p?: null | Quad_Predicate,
    o?: null | Quad_Object,
    g?: null | Quad_Graph,
): undefined | null | Node
Gets the node matching the specified pattern. Throws when no match could be made.
Parameters
- Optionals: null | Quad_Subject
  The subject
- Optionalp: null | Quad_Predicate
  The predicate
- Optionalo: null | Quad_Object
  The object
- Optionalg: null | Quad_Graph
  The graph that contains the statement
Returns undefined | null | Node
- Defined in node_modules/rdflib/lib/formula.d.ts:287

toCanonical

toCanonical(): string
Creates a canonical string representation of this node

Returns string
Inherited from Node.toCanonical
- Defined in node_modules/rdflib/lib/node-internal.d.ts:50

toNQ

toNQ(): string
Creates a n-quads string representation of this node

Returns string
Inherited from Node.toNQ
- Defined in node_modules/rdflib/lib/node-internal.d.ts:58

toNT

toNT(): string
Creates a n-triples string representation of this node

Returns string
Inherited from Node.toNT
- Defined in node_modules/rdflib/lib/node-internal.d.ts:54

topTypeURIs

topTypeURIs(
types: { [id: string]: string | NamedNode },
): { [id: string]: string | NamedNode }
Finds the types in the list which have no stored supertypes We exclude the universal class, owl:Things and rdf:Resource, as it is information-free.
Parameters
- types: { [id: string]: string | NamedNode }
  The types
Returns { [id: string]: string | NamedNode }
- Defined in node_modules/rdflib/lib/formula.d.ts:305

toString

toString(): string
Serializes this formula to a string

Returns string
Overrides Node.toString
- Defined in node_modules/rdflib/lib/formula.d.ts:313

transitiveClosure

transitiveClosure(
    seeds: BooleanMap,
    predicate: Quad_Predicate,
    inverse?: boolean,
): { [uri: string]: boolean }
RDFS Inference These are hand-written implementations of a backward-chaining reasoner over the RDFS axioms.
Parameters
- seeds: BooleanMap
  A hash of NTs of classes to start with
- predicate: Quad_Predicate
  The property to trace though
- Optionalinverse: boolean
  Trace inverse direction
Returns { [uri: string]: boolean }
- Defined in node_modules/rdflib/lib/formula.d.ts:296

variable

variable(name: string): Variable
Gets a new variable
Parameters
- name: string
  The variable's name
Returns Variable
- Defined in node_modules/rdflib/lib/formula.d.ts:318

whether

whether(
    s?: null | Quad_Subject,
    p?: null | Quad_Predicate,
    o?: null | Quad_Object,
    g?: null | Quad_Graph,
): number
Gets the number of statements in this formula that matches the specified pattern
Parameters
- Optionals: null | Quad_Subject
  The subject
- Optionalp: null | Quad_Predicate
  The predicate
- Optionalo: null | Quad_Object
  The object
- Optionalg: null | Quad_Graph
  The graph that contains the statement
Returns number
- Defined in node_modules/rdflib/lib/formula.d.ts:326

Class Formula

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rdfFactory

Returns Formula

Properties

classOrder

constraints

Optionalfetcher

initBindings

isVar

ns

Type declaration

Parameters

Returns (ln: string) => NamedNode

Param: nsuri

optional

rdfFactory

statements

termType

value

StaticfromValue

StatictoJS

Methods

add

Parameters

Returns | null | number | Formula | Statement<SubjectType, PredicateType, ObjectType, GraphType>

addAll

Parameters

Returns void

addStatement

Parameters

Returns | null | number | Formula | Statement<SubjectType, PredicateType, ObjectType, GraphType>

any

Parameters

Returns null | Node

anyJS

Parameters

Returns any

anyStatementMatching

Parameters

Returns undefined | Statement<SubjectType, PredicateType, ObjectType, GraphType>

anyValue

Parameters

Returns string | void

bnode

Parameters

Returns BlankNode

bottomTypeURIs

Parameters

Returns any

collection

Returns Collection

compareTerm

Parameters

Returns number

See

connectedStatements

Parameters

Returns Statement<SubjectType, PredicateType, ObjectType, GraphType>[]

each

Parameters

Returns Node[]

equals

Parameters

Returns boolean

findMembersNT

Parameters

Returns MembersMap

findMemberURIs

Parameters

Returns UriMap

findSubClassesNT

Parameters

`Optional`fetcher

`Static`fromValue

`Static`toJS

Returns
| null
| number
| Formula
| Statement<SubjectType, PredicateType, ObjectType, GraphType>

Returns
| null
| number
| Formula
| Statement<SubjectType, PredicateType, ObjectType, GraphType>