Class Formula

A formula, or store of RDF statements

Hierarchy

Node
- Formula
  - Store

Constructors

constructor

new Formula(statements?, constraints?, initBindings?, optional?, opts?): Formula
Initializes this formula
Parameters
- statements: Statement<SubjectType, PredicateType, ObjectType, GraphType>[] = []
  
  Initial array of statements
- constraints: readonly any[] = []
  
  initial array of constraints
- initBindings: readonly any[] = []
  
  initial bindings used in Query
- optional: readonly any[] = []
  
  optional
- opts: FormulaOpts = {}
Returns Formula
Overrides Node.constructor
- Defined in src/formula.ts:88

Properties

classOrder

classOrder: number = ClassOrder.Graph

The class order for this node

constraints

constraints: readonly any[] = []

initial array of constraints

`Optional` fetcher

fetcher?: Fetcher

The accompanying fetcher instance.

Is set by the fetcher when initialized.

initBindings

initBindings: readonly any[] = []

initial bindings used in Query

isVar

isVar: number = 0

ns

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

Type declaration

- (nsuri, factory?): ((ln) => NamedNode)
- A namespace for the specified namespace's URI
  Parameters
  - nsuri: string
    
    The URI for the namespace
  - Optional factory: RdfJsDataFactory
  Returns ((ln) => NamedNode)
  - - (ln): NamedNode
    - Parameters
      
      ln: string
      Returns NamedNode

optional

optional: readonly any[] = []

optional

rdfFactory

rdfFactory: any

The factory used to generate statements and terms

statements

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

Initial array of statements

termType

termType: "Graph" = GraphTermType

The type of node

value

value: string

The node's value

`Static` fromValue

fromValue: (<T>(value) => T)

Type declaration

- <T>(value): T
- Type Parameters
  - T extends FromValueReturns
  Parameters
  - value: ValueType
  Returns T

`Static` toJS

Type declaration

- (term): string | boolean | object | Number | Date | (string | boolean | object | Number | Date)[]
- Parameters
  - term: any
  Returns string | boolean | object | Number | Date | (string | boolean | object | Number | Date)[]

Methods

NTtoURI

NTtoURI(t): {}
Transform a collection of NTriple URIs into their URI strings

Returns
A collection of the URIs as strings todo: explain why it is important to go through NT
Parameters
- t: any
  
  Some iterable collection of NTriple URI strings
Returns {}
- Defined in src/formula.ts:705

add

add(subject, predicate?, object?, graph?): null | number | Statement<SubjectType, PredicateType, ObjectType, GraphType> | Formula
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
- Optional predicate: Quad_Predicate
  
  the second part of the statement
- Optional object: string | Term
  
  the third part of the statement
- Optional graph: Quad_Graph
  
  the last part of the statement
Returns null | number | Statement<SubjectType, PredicateType, ObjectType, GraphType> | Formula
- Defined in src/formula.ts:110

addAll

addAll(statements): 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 src/formula.ts:141

addStatement

addStatement(statement): null | number | Statement<SubjectType, PredicateType, ObjectType, GraphType> | Formula
Add a statment object
Parameters
- statement: Quad<Quad_Subject, Quad_Predicate, Quad_Object, Quad_Graph>
  
  An existing constructed statement to add
Returns null | number | Statement<SubjectType, PredicateType, ObjectType, GraphType> | Formula
- Defined in src/formula.ts:125

any

any(s?, p?, o?, g?): 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 .

Returns
A node which match the wildcard position, or null
Parameters
- Optional s: null | Quad_Subject
  
  A node to search for as subject, or if null, a wildcard
- Optional p: null | Quad_Predicate
  
  A node to search for as predicate, or if null, a wildcard
- Optional o: null | Quad_Object
  
  A node to search for as object, or if null, a wildcard
- Optional g: null | Quad_Graph
  
  A node to search for as graph, or if null, a wildcard
Returns null | Node
- Defined in src/formula.ts:159

anyJS

anyJS(s?, p?, o?, g?): any
Gets the first JavaScript object equivalent to a node based on the specified pattern
Parameters
- Optional s: null | Quad_Subject
  
  The subject
- Optional p: null | Quad_Predicate
  
  The predicate
- Optional o: null | Quad_Object
  
  The object
- Optional g: null | Quad_Graph
  
  The graph that contains the statement
Returns any
- Defined in src/formula.ts:203

anyStatementMatching

anyStatementMatching(s?, p?, o?, g?): undefined | Statement<SubjectType, PredicateType, ObjectType, GraphType>
Gets the first statement that matches the specified pattern
Parameters
- Optional s: null | Quad_Subject
- Optional p: null | Quad_Predicate
- Optional o: null | Quad_Object
- Optional g: null | Quad_Graph
Returns undefined | Statement<SubjectType, PredicateType, ObjectType, GraphType>
- Defined in src/formula.ts:216

anyValue

anyValue(s?, p?, o?, g?): string | void
Gets the value of a node that matches the specified pattern
Parameters
- Optional s: null | Quad_Subject
  
  The subject
- Optional p: null | Quad_Predicate
  
  The predicate
- Optional o: null | Quad_Object
  
  The object
- Optional g: null | Quad_Graph
  
  The graph that contains the statement
Returns string | void
- Defined in src/formula.ts:186

bnode

bnode(id?): BlankNode
Shortcut for adding blankNodes
Parameters
- Optional id: string
Returns BlankNode
- Defined in src/formula.ts:133

bottomTypeURIs

bottomTypeURIs(types): 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 src/formula.ts:278

collection

collection(): Collection<Node | BlankNode | Collection<any> | Literal | Variable>
Creates a new collection

Returns Collection<Node | BlankNode | Collection<any> | Literal | Variable>
- Defined in src/formula.ts:314

compareTerm

compareTerm(other): number
Compares this node with another

See
to check if two nodes are equal
Parameters
- other: Node
  
  The other node
Returns number
Inherited from Node.compareTerm
- Defined in src/node-internal.ts:44

connectedStatements

connectedStatements(subject, doc, excludePredicateURIs?): Statement<SubjectType, PredicateType, ObjectType, GraphType>[]
Trace statements which connect directly, or through bnodes

Returns
an array of statements, duplicate statements are suppresssed.
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
- Optional excludePredicateURIs: readonly string[]
Returns Statement<SubjectType, PredicateType, ObjectType, GraphType>[]
- Defined in src/formula.ts:555

each

each(s?, p?, o?, g?): 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 .

Returns
- An array of nodes which match the wildcard position
Parameters
- Optional s: null | Quad_Subject
  
  A node to search for as subject, or if null, a wildcard
- Optional p: null | Quad_Predicate
  
  A node to search for as predicate, or if null, a wildcard
- Optional o: null | Quad_Object
  
  A node to search for as object, or if null, a wildcard
- Optional g: null | Quad_Graph
  
  A node to search for as graph, or if null, a wildcard
Returns Node[]
- Defined in src/formula.ts:330

equals

equals(other): boolean
Test whether this formula is equals to {other}
Parameters
- other: Formula
  
  The other formula
Returns boolean
Overrides Node.equals
- Defined in src/formula.ts:363

findMemberURIs

findMemberURIs(subject): 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 src/formula.ts:443

findMembersNT

findMembersNT(thisClass): 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

Returns
a hash of URIs
Parameters
- thisClass: any
Returns MembersMap
- Defined in src/formula.ts:379

findSubClassesNT

findSubClassesNT(subject): {
[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;
}
- [uri: string]: boolean
- Defined in src/formula.ts:454

findSuperClassesNT

findSuperClassesNT(subject): {
[uri: string]: boolean;
}
Get all the Classes of which we can RDFS-infer the subject is a subclass

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
  
  The thing whose classes are to be found
Returns {
[uri: string]: boolean;
}
- [uri: string]: boolean
- Defined in src/formula.ts:472

findTypeURIs

findTypeURIs(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 src/formula.ts:545

findTypesNT

findTypesNT(subject): {
[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)

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: any
  
  The thing whose classes are to be found
Returns {
[uri: string]: boolean;
}
- [uri: string]: boolean
- Defined in src/formula.ts:488

formula

formula(_features?): Formula
Creates a new empty formula
Parameters
- Optional _features: readonly string[]
  
  Not applicable, but necessary for typing to pass
Returns Formula
- Defined in src/formula.ts:600

fromNT

fromNT(str): 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 src/formula.ts:610

hashString

hashString(): string
Creates a hash for this node

Deprecated
use {rdfFactory.id} instead if possible

Returns string
Inherited from Node.hashString
- Defined in src/node-internal.ts:76

holds

holds(s, p?, o?, g?): boolean
Returns true if this formula holds the specified statement(s)
Parameters
- s: any
- Optional p: any
- Optional o: any
- Optional g: any
Returns boolean
- Defined in src/formula.ts:642

holdsStatement

holdsStatement(statement): boolean
Returns true if this formula holds the specified {statement}
Parameters
- statement: any
Returns boolean
- Defined in src/formula.ts:669

id

id(term): 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 src/formula.ts:235

list

list(values, context): any
Used by the n3parser to generate list elements

Returns
- The term for the statement
Parameters
- values: any
  
  The values of the collection
- context: any
  
  The store
Returns any
- Defined in src/formula.ts:684

sameTerm

sameTerm(other): 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 src/node-internal.ts:84

serialize

serialize(base, contentType, provenance, options?): 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
- Optional options: any
  
  options to pass to the serializer, as defined in serialize method
Returns undefined | string
- Defined in src/formula.ts:725

statementsMatching

statementsMatching<JustOne>(s?, p?, o?, g?, justOne?): Statement<SubjectType, PredicateType, ObjectType, GraphType>[]
Search the Store This is really a teaching method as to do this properly you would use IndexedFormula

Returns
- An array of nodes which match the wildcard position
Type Parameters
- JustOne extends boolean = false
Parameters
- Optional s: null | Quad_Subject
  
  A node to search for as subject, or if null, a wildcard
- Optional p: null | Quad_Predicate
  
  A node to search for as predicate, or if null, a wildcard
- Optional o: null | Quad_Object
  
  A node to search for as object, or if null, a wildcard
- Optional g: null | Quad_Graph
  
  A node to search for as graph, or if null, a wildcard
- Optional justOne: boolean
  
  flag - stop when found one rather than get all of them?
Returns Statement<SubjectType, PredicateType, ObjectType, GraphType>[]
- Defined in src/formula.ts:250

substitute

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

sym

sym(uri, name?): NamedNode
Parameters
- uri: string
- Optional name: any
Returns NamedNode
- Defined in src/formula.ts:745

the

the(s?, p?, o?, g?): undefined | null | Node
Gets the node matching the specified pattern. Throws when no match could be made.
Parameters
- Optional s: null | Quad_Subject
  
  The subject
- Optional p: null | Quad_Predicate
  
  The predicate
- Optional o: null | Quad_Object
  
  The object
- Optional g: null | Quad_Graph
  
  The graph that contains the statement
Returns undefined | null | Node
- Defined in src/formula.ts:759

toCanonical

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

Returns string
Inherited from Node.toCanonical
- Defined in src/node-internal.ts:92

toNQ

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

Returns string
Inherited from Node.toNQ
- Defined in src/node-internal.ts:106

toNT

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

Returns string
Inherited from Node.toNT
- Defined in src/node-internal.ts:99

toString

toString(): string
Serializes this formula to a string

Returns string
Overrides Node.toString
- Defined in src/formula.ts:872

topTypeURIs

topTypeURIs(types): {
[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
  - [id: string]: string | NamedNode
Returns {
[id: string]: string | NamedNode;
}
- [id: string]: string | NamedNode
- Defined in src/formula.ts:827

transitiveClosure

transitiveClosure(seeds, predicate, inverse?): {
[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
- Optional inverse: boolean
  
  Trace inverse direction
Returns {
[uri: string]: boolean;
}
- [uri: string]: boolean
- Defined in src/formula.ts:781

variable

variable(name): Variable
Gets a new variable
Parameters
- name: string
  
  The variable's name
Returns Variable
- Defined in src/formula.ts:880

whether

whether(s?, p?, o?, g?): number
Gets the number of statements in this formula that matches the specified pattern
Parameters
- Optional s: null | Quad_Subject
  
  The subject
- Optional p: null | Quad_Predicate
  
  The predicate
- Optional o: null | Quad_Object
  
  The object
- Optional g: null | Quad_Graph
  
  The graph that contains the statement
Returns number
- Defined in src/formula.ts:891

Class Formula

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

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

constraints: readonly any[] = []

initBindings: readonly any[] = []

optional: readonly any[] = []

opts: FormulaOpts = {}

Returns Formula

Properties

classOrder

constraints

Optional fetcher

initBindings

isVar

ns

Type declaration

Parameters

nsuri: string

Optional factory: RdfJsDataFactory

Returns ((ln) => NamedNode)

Parameters

ln: string

Returns NamedNode

optional

rdfFactory

statements

termType

value

Static fromValue

Type declaration

Type Parameters

T extends FromValueReturns

Parameters

value: ValueType

Returns T

Static toJS

Type declaration

Parameters

term: any

Returns string | boolean | object | Number | Date | (string | boolean | object | Number | Date)[]

Methods

NTtoURI

Returns

Parameters

t: any

Returns {}

add

Parameters

subject: Quad_Subject | Quad<Quad_Subject, Quad_Predicate, Quad_Object, Quad_Graph> | Quad<Quad_Subject, Quad_Predicate, Quad_Object, Quad_Graph>[]

Optional predicate: Quad_Predicate

Optional object: string | Term

Optional graph: Quad_Graph

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

addAll

Parameters

statements: Quad<Quad_Subject, Quad_Predicate, Quad_Object, Quad_Graph>[]

Returns void

addStatement

Parameters

statement: Quad<Quad_Subject, Quad_Predicate, Quad_Object, Quad_Graph>

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

any

Returns

Parameters

Optional s: null | Quad_Subject

Optional p: null | Quad_Predicate

Optional o: null | Quad_Object

Optional g: null | Quad_Graph

Returns null | Node

anyJS

Parameters

Optional s: null | Quad_Subject

Optional p: null | Quad_Predicate

`Optional` fetcher

`Optional` factory: RdfJsDataFactory

`Static` fromValue

`Static` toJS

`Optional` predicate: Quad_Predicate

`Optional` object: string | Term

`Optional` graph: Quad_Graph

`Optional` s: null | Quad_Subject

`Optional` p: null | Quad_Predicate

`Optional` o: null | Quad_Object

`Optional` g: null | Quad_Graph

`Optional` s: null | Quad_Subject

`Optional` p: null | Quad_Predicate

`Optional` o: null | Quad_Object

`Optional` g: null | Quad_Graph

`Optional` s: null | Quad_Subject

`Optional` p: null | Quad_Predicate

`Optional` o: null | Quad_Object

`Optional` g: null | Quad_Graph

`Optional` s: null | Quad_Subject

`Optional` p: null | Quad_Predicate

`Optional` o: null | Quad_Object

`Optional` g: null | Quad_Graph

`Optional` id: string

`Optional` excludePredicateURIs: readonly string[]

`Optional` s: null | Quad_Subject

`Optional` p: null | Quad_Predicate

`Optional` o: null | Quad_Object

`Optional` g: null | Quad_Graph

Returns {
[uri: string]: boolean;
}

Returns {
[uri: string]: boolean;
}