RedlandModel Class Reference
| Inherits from | RedlandWrappedObject : NSObject |
| Declared in | RedlandModel.h RedlandModel.m |
Overview
This class provides the RDF model support.
A model is a set of statements (duplicates are not allowed, except in separate Redland contexts). Models can have statements added and removed, be queried and stored which is implemented by the RedlandStorage class. Wraps librdf_model.
RedlandModel(SerializerConvenience)
Category to add convenience parsing methods to RedlandModel.
Tasks
Other Methods
-
– initWithStorage:Initialises a new RedlandModel using the given storage.
-
– wrappedModelReturns the underlying librdf_model pointer of the receiver.
-
– sizeReturns the number of statements in the receiver.
-
– syncSynchronises the model to the model implementation.
-
– storageReturns the underlying RedlandStorage of the receiver.
-
– addStatement:Adds a single statement to the receiver. Duplicate statements are ignored.
-
– addStatementsFromStream:Adds a stream of statements to the receiver. Duplicate statements are ignored.
-
– addStatement:withContext:Adds a single statement to the receiver with the given context.
-
– addStatementsFromStream:withContext:Adds a stream of statements to the receiver in the given context.
-
– containsStatement:Returns YES if the receiver contains the given statement.
-
– removeStatement:Removes a single statement from the receiver.
-
– removeStatement:withContext:Removes a single statement with the given context from the receiver.
-
– removeStatementsLike:Removes all statements matching the given statement.
-
– removeAllStatementsWithContext:Removes all statements with the given context from the receiver.
-
– containsContext:Check for a context in the model.
-
– submodelForSubject:Creates a sub-model from triples found in the receiver that relate to the given subject node.
-
– addSubmodel:Add a submodel to the receiver.
-
– removeSubmodel:Remove a submodel from the receiver.
-
– statementsLike:withDescendants:Returns all statements in the receiver that match the given statement, recursively if desired.
-
– statementStreamReturns a stream of all statements in the receiver.
-
– streamOfStatementsLike:Returns a RedlandStream of all statements matching the given statement.
-
– streamOfStatementsLike:withContext:Returns a RedlandStream of statements matching the given statement and context.
-
– streamOfAllStatementsWithContext:Returns a stream of all statements with the given context.
-
– sourceWithArc:target:Returns one matching source in the receiver for the given arcNode and targetNode.
-
– arcWithSource:target:Returns one matching arc in the receiver for the given sourceNode and targetNode.
-
– targetWithSource:arc:Returns one matching target in the receiver for the given sourceNode and arcNode.
-
– node:hasIncomingArc:Returns YES if targetNode has at least one incoming arc arcNode.
-
– node:hasOutgoingArc:Returns YES if sourceNode has at least one outgoing arc arcNode.
-
– valueOfFeature:Returns the value of the model feature identified by featureURI.
-
– setValue:ofFeature:Sets the model feature identified by featureURI to a new value.
SerializerConvenience Methods
-
– serializedRDFXMLDataWithBaseURI:Returns an RDF/XML serialization of the receiver using the given base URI.
Convenience Methods
-
– enumeratorOfStatementsLike:Returns an enumerator of all statements in the receiver that match the given statement.
-
– enumeratorOfStatementsLike:withContext:Returns an enumerator of all statements in the receiver that match the given statement and context.
-
– statementEnumeratorReturns an enumerator of all statements in the receiver.
-
– statementEnumeratorWithContext:Returns an enumerator of all statements in the receiver with the given context.
-
– enumeratorOfSourcesWithArc:target:Returns an enumerator of all sources in the receiver that have the given arcNode and targetNode.
-
– enumeratorOfSourcesWithArc:target:context:Returns an enumerator of all sources in the receiver that have the given arcNode, targetNode, and contextNode.
-
– enumeratorOfArcsWithSource:target:Returns an enumerator of all arcs in the receiver with the given sourceNode and targetNode.
-
– enumeratorOfArcsWithSource:target:context:Returns an enumerator of all arcs in the receiver with the given sourceNode, targetNode, and context.
-
– enumeratorOfTargetsWithSource:arc:Returns an enumerator of all targets in the receiver with the given sourceNode and arcNode.
-
– enumeratorOfTargetsWithSource:arc:context:Returns an enumerator of all targets in the receiver with the given sourceNode, arcNode, and contextNode.
-
– enumeratorOfArcsIn:Returns an enumerator of all arcs going into targetNode.
-
– enumeratorOfArcsIn:context:Returns an enumerator of all arcs going into targetNode in context contextNode.
-
– enumeratorOfArcsOut:Returns an enumerator of all arcs coming out of sourceNode.
-
– enumeratorOfArcsOut:context:Returns an enumerator of all arcs coming out of sourceNode in context contextNode.
-
– contextEnumeratorReturns an NSEnumerator of all contexts in the receiver.
ParserConvenience Methods
-
– loadURL:withContext:Fetches data from the given URL using the Cocoa NSURL loading system, parses it with a parser deduced from the returned MIME type, and adds the statements into the given context of the receiver.
Instance Methods
addStatement:
Adds a single statement to the receiver. Duplicate statements are ignored.
- (void)addStatement:(RedlandStatement *)aStatementParameters
- aStatement
A complete statement (with non-nil subject, predicate, and object)
Discussion
Adds a single statement to the receiver. Duplicate statements are ignored.
Declared In
RedlandModel.maddStatement:withContext:
Adds a single statement to the receiver with the given context.
- (void)addStatement:(RedlandStatement *)aStatement withContext:(RedlandNode *)contextNodeParameters
- aStatement
A complete statement
- contextNode
The context to associate this statement with
Discussion
Adds a single statement to the receiver with the given context.
Declared In
RedlandModel.maddStatementsFromStream:
Adds a stream of statements to the receiver. Duplicate statements are ignored.
- (void)addStatementsFromStream:(RedlandStream *)aStreamParameters
- aStream
A stream of complete statements
Discussion
Adds a stream of statements to the receiver. Duplicate statements are ignored.
Declared In
RedlandModel.maddStatementsFromStream:withContext:
Adds a stream of statements to the receiver in the given context.
- (void)addStatementsFromStream:(RedlandStream *)aStream withContext:(RedlandNode *)contextNodeParameters
- aStream
A stream of complete statements
- contextNode
The context to associate each statement with
Discussion
Adds a stream of statements to the receiver in the given context.
Declared In
RedlandModel.maddSubmodel:
Add a submodel to the receiver.
- (BOOL)addSubmodel:(RedlandModel *)submodelParameters
- submodel
The submodel to add to the model, must not be nil
Return Value
A BOOL whether the action was successful
Discussion
Add a submodel to the receiver.
Warning: Redland has a function “librdf_model_add_submodel”, however it is labelled with a “FIXME: Not tested” and I was having trouble getting it to work properly. For this reason this method currently simply adds the statements/triples found in the submodel to the model. This will fail if any statement already exists in the model (but it will not raise an exception).
Declared In
RedlandModel.marcWithSource:target:
Returns one matching arc in the receiver for the given sourceNode and targetNode.
- (RedlandNode *)arcWithSource:(RedlandNode *)sourceNode target:(RedlandNode *)targetNodeParameters
- sourceNode
The source (or subject)
- targetNode
The target (or object)
Discussion
Returns one matching arc in the receiver for the given sourceNode and targetNode.
Declared In
RedlandModel.mcontainsContext:
Check for a context in the model.
- (BOOL)containsContext:(RedlandNode *)contextNodeParameters
- contextNode
A RedlandNode representing the context
Return Value
YES if the model does contain the specified context
Discussion
Check for a context in the model.
Declared In
RedlandModel.mcontainsStatement:
Returns YES if the receiver contains the given statement.
- (BOOL)containsStatement:(RedlandStatement *)aStatementParameters
- aStatement
A complete statement
Discussion
Returns YES if the receiver contains the given statement.
Warning: May not work in all cases; use enumeratorOfStatementsLike: instead.
Declared In
RedlandModel.mcontextEnumerator
Returns an NSEnumerator of all contexts in the receiver.
- (NSEnumerator *)contextEnumeratorReturn Value
An NSEnumerator
Discussion
Returns an NSEnumerator of all contexts in the receiver.
Declared In
RedlandModel-Convenience.menumeratorOfArcsIn:
Returns an enumerator of all arcs going into targetNode.
- (NSEnumerator *)enumeratorOfArcsIn:(RedlandNode *)targetNodeParameters
- targetNode
The node to use as target/object
Return Value
An NSEnumerator
Discussion
Returns an enumerator of all arcs going into targetNode.
Declared In
RedlandModel-Convenience.menumeratorOfArcsIn:context:
Returns an enumerator of all arcs going into targetNode in context contextNode.
- (NSEnumerator *)enumeratorOfArcsIn:(RedlandNode *)targetNode context:(RedlandNode *)contextNodeParameters
- targetNode
The node to use as target/object
- contextNode
The node to use as context
Return Value
An NSEnumerator
Discussion
Returns an enumerator of all arcs going into targetNode in context contextNode.
Declared In
RedlandModel-Convenience.menumeratorOfArcsOut:
Returns an enumerator of all arcs coming out of sourceNode.
- (NSEnumerator *)enumeratorOfArcsOut:(RedlandNode *)sourceNodeDiscussion
Returns an enumerator of all arcs coming out of sourceNode.
Declared In
RedlandModel-Convenience.menumeratorOfArcsOut:context:
Returns an enumerator of all arcs coming out of sourceNode in context contextNode.
- (NSEnumerator *)enumeratorOfArcsOut:(RedlandNode *)targetNode context:(RedlandNode *)contextNodeParameters
- targetNode
The node to use as subject (!)
- contextNode
The node to use as context
Return Value
An NSEnumerator
Discussion
Returns an enumerator of all arcs coming out of sourceNode in context contextNode.
Declared In
RedlandModel-Convenience.menumeratorOfArcsWithSource:target:
Returns an enumerator of all arcs in the receiver with the given sourceNode and targetNode.
- (NSEnumerator *)enumeratorOfArcsWithSource:(RedlandNode *)sourceNode target:(RedlandNode *)targetNodeParameters
- sourceNode
The node to use as source/subject
- targetNode
The node to use as target/object
Return Value
An NSEnumerator
Discussion
Returns an enumerator of all arcs in the receiver with the given sourceNode and targetNode.
Declared In
RedlandModel-Convenience.menumeratorOfArcsWithSource:target:context:
Returns an enumerator of all arcs in the receiver with the given sourceNode, targetNode, and context.
- (NSEnumerator *)enumeratorOfArcsWithSource:(RedlandNode *)sourceNode target:(RedlandNode *)targetNode context:(RedlandNode *)contextNodeParameters
- sourceNode
The node to use as source/subject
- targetNode
The node to use as target/object
- contextNode
The node to use as context
Return Value
An NSEnumerator
Discussion
Returns an enumerator of all arcs in the receiver with the given sourceNode, targetNode, and context.
Declared In
RedlandModel-Convenience.menumeratorOfSourcesWithArc:target:
Returns an enumerator of all sources in the receiver that have the given arcNode and targetNode.
- (NSEnumerator *)enumeratorOfSourcesWithArc:(RedlandNode *)arcNode target:(RedlandNode *)targetNodeParameters
- arcNode
The node to use as arc/predicate
- targetNode
The node to use as target/object
Return Value
An NSEnumerator
Discussion
Returns an enumerator of all sources in the receiver that have the given arcNode and targetNode.
Declared In
RedlandModel-Convenience.menumeratorOfSourcesWithArc:target:context:
Returns an enumerator of all sources in the receiver that have the given arcNode, targetNode, and contextNode.
- (NSEnumerator *)enumeratorOfSourcesWithArc:(RedlandNode *)arcNode target:(RedlandNode *)targetNode context:(RedlandNode *)contextNodeParameters
- arcNode
The node to use as arc/predicate
- targetNode
The node to use as target/object
- contextNode
The node to use as context
Return Value
An NSEnumerator
Discussion
Returns an enumerator of all sources in the receiver that have the given arcNode, targetNode, and contextNode.
Declared In
RedlandModel-Convenience.menumeratorOfStatementsLike:
Returns an enumerator of all statements in the receiver that match the given statement.
- (RedlandStreamEnumerator *)enumeratorOfStatementsLike:(RedlandStatement *)aStatementParameters
- aStatement
A (possibly partial) statement.
Return Value
A RedlandStreamEnumerator of the matching statements
Discussion
Returns an enumerator of all statements in the receiver that match the given statement.
Declared In
RedlandModel-Convenience.menumeratorOfStatementsLike:withContext:
Returns an enumerator of all statements in the receiver that match the given statement and context.
- (RedlandStreamEnumerator *)enumeratorOfStatementsLike:(RedlandStatement *)aStatement withContext:(RedlandNode *)contextNodeParameters
- aStatement
A (possibly partial) statement
- contextNode
The context
Return Value
A RedlandStreamEnumerator of the matching statements
Discussion
Returns an enumerator of all statements in the receiver that match the given statement and context.
Declared In
RedlandModel-Convenience.menumeratorOfTargetsWithSource:arc:
Returns an enumerator of all targets in the receiver with the given sourceNode and arcNode.
- (NSEnumerator *)enumeratorOfTargetsWithSource:(RedlandNode *)sourceNode arc:(RedlandNode *)arcNodeParameters
- sourceNode
The node to use as source/subject
- arcNode
The node to use as arc/predicate
Return Value
An NSEnumerator
Discussion
Returns an enumerator of all targets in the receiver with the given sourceNode and arcNode.
Declared In
RedlandModel-Convenience.menumeratorOfTargetsWithSource:arc:context:
Returns an enumerator of all targets in the receiver with the given sourceNode, arcNode, and contextNode.
- (NSEnumerator *)enumeratorOfTargetsWithSource:(RedlandNode *)sourceNode arc:(RedlandNode *)arcNode context:(RedlandNode *)contextNodeParameters
- sourceNode
The node to use as source/subject
- arcNode
The node to use as arc/predicate
- contextNode
The node to use as context
Return Value
An NSEnumerator
Discussion
Returns an enumerator of all targets in the receiver with the given sourceNode, arcNode, and contextNode.
Declared In
RedlandModel-Convenience.minitWithStorage:
Initialises a new RedlandModel using the given storage.
- (id)initWithStorage:(RedlandStorage *)aStorageParameters
- aStorage
The storage to use for the new model
Discussion
Initialises a new RedlandModel using the given storage.
Declared In
RedlandModel.mloadURL:withContext:
Fetches data from the given URL using the Cocoa NSURL loading system, parses it with a parser deduced from the returned MIME type, and adds the statements into the given context of the receiver.
- (void)loadURL:(NSURL *)aURL withContext:(RedlandNode *)contextParameters
- aURL
The NSURL to load
- context
an optional context
Discussion
Fetches data from the given URL using the Cocoa NSURL loading system, parses it with a parser deduced from the returned MIME type, and adds the statements into the given context of the receiver.
Warning: This is a nice and uncomplicated convenience function, but it will block until the data has been downloaded and parsed. If the parser type cannot be guessed from the MIME type, an RDF/XML parser will be used.
Declared In
RedlandParser.mnode:hasIncomingArc:
Returns YES if targetNode has at least one incoming arc arcNode.
- (BOOL)node:(RedlandNode *)targetNode hasIncomingArc:(RedlandNode *)arcNodeParameters
- targetNode
The node to query
- arcNode
The arc (or predicate)
Discussion
Returns YES if targetNode has at least one incoming arc arcNode.
Declared In
RedlandModel.mnode:hasOutgoingArc:
Returns YES if sourceNode has at least one outgoing arc arcNode.
- (BOOL)node:(RedlandNode *)sourceNode hasOutgoingArc:(RedlandNode *)arcNodeParameters
- sourceNode
The node to query
- arcNode
The arc (or predicate)
Discussion
Returns YES if sourceNode has at least one outgoing arc arcNode.
Declared In
RedlandModel.mremoveAllStatementsWithContext:
Removes all statements with the given context from the receiver.
- (void)removeAllStatementsWithContext:(RedlandNode *)contextNodeParameters
- contextNode
The context of the statements to remove
Discussion
Removes all statements with the given context from the receiver.
Declared In
RedlandModel.mremoveStatement:
Removes a single statement from the receiver.
- (BOOL)removeStatement:(RedlandStatement *)aStatementParameters
- aStatement
A complete statement
Return Value
YES on success
Discussion
Removes a single statement from the receiver.
Declared In
RedlandModel.mremoveStatement:withContext:
Removes a single statement with the given context from the receiver.
- (BOOL)removeStatement:(RedlandStatement *)aStatement withContext:(RedlandNode *)contextNodeParameters
- aStatement
A complete statement
- contextNode
The context of the statement to remove
Return Value
YES on success
Discussion
Removes a single statement with the given context from the receiver.
Declared In
RedlandModel.mremoveStatementsLike:
Removes all statements matching the given statement.
- (void)removeStatementsLike:(RedlandStatement *)aStatementParameters
- aStatement
The RedlandStatement to find matches for
Discussion
Removes all statements matching the given statement.
At least one of the statement’s subject, predicate or object must be set.
Declared In
RedlandModel.mremoveSubmodel:
Remove a submodel from the receiver.
- (BOOL)removeSubmodel:(RedlandModel *)submodelParameters
- submodel
The submodel to remove from the model, must not be nil
Return Value
A BOOL whether the action was successful
Discussion
Remove a submodel from the receiver.
Warning: Redland has a function “librdf_model_remove_submodel”, however it is labelled with a “FIXME: Not tested” and I was having trouble getting it to work properly. For this reason this method currently simply removes the statements/triples found in the submodel from the model. This will fail if any statement fails to be removed from the model (but it will not raise an exception).
Declared In
RedlandModel.mserializedRDFXMLDataWithBaseURI:
Returns an RDF/XML serialization of the receiver using the given base URI.
- (NSData *)serializedRDFXMLDataWithBaseURI:(RedlandURI *)baseURIParameters
- baseURI
The base-URI to use as RedlandURI
Return Value
NSData
Discussion
Returns an RDF/XML serialization of the receiver using the given base URI.
Declared In
RedlandSerializer.msetValue:ofFeature:
Sets the model feature identified by featureURI to a new value.
- (void)setValue:(RedlandNode *)featureValue ofFeature:(id)featureURIParameters
- featureValue
A RedlandNode representing the new value
- featureURI
An NSString or a RedlandURI instance
Discussion
Sets the model feature identified by featureURI to a new value.
Warning: Raises a RedlandException is no such feature exists.
Declared In
RedlandModel.msize
Returns the number of statements in the receiver.
- (int)sizeReturn Value
The number of statements in the model, or a negative value on failure.
Discussion
Returns the number of statements in the receiver.
Warning: Not all stores support this function. If you absolutely need an accurate size, you can enumerate the statements manually. Also, for submodels with the same store this still returns the size of the parent model.
Declared In
RedlandModel.msourceWithArc:target:
Returns one matching source in the receiver for the given arcNode and targetNode.
- (RedlandNode *)sourceWithArc:(RedlandNode *)arcNode target:(RedlandNode *)targetNodeParameters
- arcNode
The arc (or predicate)
- targetNode
The target (or object)
Discussion
Returns one matching source in the receiver for the given arcNode and targetNode.
Declared In
RedlandModel.mstatementEnumerator
Returns an enumerator of all statements in the receiver.
- (RedlandStreamEnumerator *)statementEnumeratorDiscussion
Returns an enumerator of all statements in the receiver.
Declared In
RedlandModel-Convenience.mstatementEnumeratorWithContext:
Returns an enumerator of all statements in the receiver with the given context.
- (RedlandStreamEnumerator *)statementEnumeratorWithContext:(RedlandNode *)contextNodeParameters
- contextNode
The context
Discussion
Returns an enumerator of all statements in the receiver with the given context.
Declared In
RedlandModel-Convenience.mstatementStream
Returns a stream of all statements in the receiver.
- (RedlandStream *)statementStreamDiscussion
Returns a stream of all statements in the receiver.
Declared In
RedlandModel.mstatementsLike:withDescendants:
Returns all statements in the receiver that match the given statement, recursively if desired.
- (NSArray *)statementsLike:(RedlandStatement *)aStatement withDescendants:(BOOL)descendantsParameters
- aStatement
The statement/triple to match against
- descendants
BOOL on whether to also retrieve descendant nodes
Return Value
An array full of matching RedlandStatement instances or nil if no statement was provided
Discussion
Returns all statements in the receiver that match the given statement, recursively if desired.
This method allows for recursive retrieval, i.e. it also returns nodes that as subject have the object of previously found triples.
Declared In
RedlandModel.mstorage
Returns the underlying RedlandStorage of the receiver.
- (RedlandStorage *)storageDiscussion
Returns the underlying RedlandStorage of the receiver.
Declared In
RedlandModel.mstreamOfAllStatementsWithContext:
Returns a stream of all statements with the given context.
- (RedlandStream *)streamOfAllStatementsWithContext:(RedlandNode *)contextNodeParameters
- contextNode
The context to stream
Discussion
Returns a stream of all statements with the given context.
Declared In
RedlandModel.mstreamOfStatementsLike:
Returns a RedlandStream of all statements matching the given statement.
- (RedlandStream *)streamOfStatementsLike:(RedlandStatement *)aStatementParameters
- aStatement
A (possibly partial) statement
Discussion
Returns a RedlandStream of all statements matching the given statement.
Declared In
RedlandModel.mstreamOfStatementsLike:withContext:
Returns a RedlandStream of statements matching the given statement and context.
- (RedlandStream *)streamOfStatementsLike:(RedlandStatement *)aStatement withContext:(RedlandNode *)contextNodeParameters
- aStatement
A (possibly partial) statement
- contextNode
The context
Discussion
Returns a RedlandStream of statements matching the given statement and context.
Declared In
RedlandModel.msubmodelForSubject:
Creates a sub-model from triples found in the receiver that relate to the given subject node.
- (RedlandModel *)submodelForSubject:(RedlandNode *)aSubjectParameters
- aSubject
The subject node for which to retrieve triples
Return Value
A RedlandModel instance or nil if no subject was provided
Discussion
Creates a sub-model from triples found in the receiver that relate to the given subject node.
Declared In
RedlandModel.msync
Synchronises the model to the model implementation.
- (void)syncDiscussion
Synchronises the model to the model implementation.
Declared In
RedlandModel.mtargetWithSource:arc:
Returns one matching target in the receiver for the given sourceNode and arcNode.
- (RedlandNode *)targetWithSource:(RedlandNode *)sourceNode arc:(RedlandNode *)arcNodeParameters
- sourceNode
The source (or subject)
- arcNode
The arc (or predicate)
Discussion
Returns one matching target in the receiver for the given sourceNode and arcNode.
Declared In
RedlandModel.mvalueOfFeature:
Returns the value of the model feature identified by featureURI.
- (RedlandNode *)valueOfFeature:(id)featureURIParameters
- featureURI
An NSString or a RedlandURI instance
Discussion
Returns the value of the model feature identified by featureURI.
Declared In
RedlandModel.m