r3 - 2020-07-09 - 15:55:00 - Main.ndjcYou are here: TWiki >

LinkedData Web > BestPractices > UseOfOSLCValueTypeAndRepresentation

This wiki: The development wiki is a work area where Jazz development teams plan and discuss technical designs and operations for the projects at Jazz.net. Work items often link to documents here. You are welcome to browse, follow along, and participate. Participation is what Jazz.net is all about! But please keep in mind that information here is "as is", unsupported, and may be outdated or inaccurate. For information on released products, consult IBM Knowledge Center, support tech notes, and the Jazz.net library. See also the Jazz.net Terms of Use.

Any documentation or reference material found in this wiki is not official product documentation, but it is primarily for the use of the development teams. For your end use, you should consult official product documentation (infocenters), IBM.com support artifacts (tech notes), and the jazz.net library as officially "stamped" resources.

Best Practice: Use of OSLC Value Type and Representation in Resource Shapes

State: Valid

Contact: Nick Crossley

Scope

The OSLC 2.0 Core specification defines two properties oslc:valueType and oslc:representation to describe the type and representation of property values. The wording of those two properties is not as precise as it could be, and the meaning of combinations of the two properties is not always clear.

Recommendation

Authors of OSLC Resource Shapes should choose the values of oslc:valueType and oslc:representation carefully, bearing in mind the resulting constraints as described in the following table. Note that the most permissive combination is oslc:valueType=oslc:AnyResource and oslc:representation=oslc:Either.

Value Type	Representation
Value Type	Reference	Inline	Either
Resource	A link to an RDF resource with a stable URI. The target RDF resource SHOULD NOT be contained within the same RDF graph or same http resource as the source resource; a client may expect to be able to GET this URI separately and independently from the source URI (and possibly PUT/POST to it).	A link to an RDF resource with a stable URI, which might be a hash URI. The target MUST be contained within the same RDF graph or same http resource as the source resource.	A link to an RDF resource with a stable URI, which might be a hash URI. The target RDF resource MAY be contained in the same graph or http resource as the source, so the GET of the source URI might also fetch the target resource.
LocalResource	n/a	A link to an RDF resource with a hash URI or blank node, The target MUST be contained within the same RDF graph or same http resource as the source resource. Clients MUST assume the resource is not separately fetchable or modifiable.	n/a
AnyResource	n/a	A link to an RDF resource. The target MUST be contained within the same RDF graph or same http resource as the source resource. Clients MUST NOT make any assumptions about the nature of the URI for this resource.	A link to a resource. The representation and location of the target is not defined. Clients MUST NOT make any assumptions about the nature of the URI for this resource.

Best Practice: Use of OSLC Value Type and Representation in Resource Shapes

Scope

Recommendation

See Also