com.github.jsonldjava.core

Class JsonLdApi

java.lang.Object

com.github.jsonldjava.core.JsonLdApi

public class JsonLdApi
extends java.lang.Object

A container object to maintain state relating to JsonLdOptions and the current Context, and push these into the relevant algorithms in JsonLdProcessor as necessary.

Constructor Summary

Constructors

Constructor and Description
JsonLdApi() Constructs an empty JsonLdApi object using the default JsonLdOptions, and without initialization.
JsonLdApi(java.lang.Object input, java.lang.Object context, JsonLdOptions opts) Constructs a JsonLdApi object using the given object as the initial JSON-LD object, the given context, and the given JsonLdOptions.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	compact(Context activeCtx, java.lang.String activeProperty, java.lang.Object element) Compaction Algorithm
java.lang.Object	compact(Context activeCtx, java.lang.String activeProperty, java.lang.Object element, boolean compactArrays) Compaction Algorithm
java.lang.Object	expand(Context activeCtx, java.lang.Object element) Expansion Algorithm
java.lang.Object	expand(Context activeCtx, java.lang.String activeProperty, java.lang.Object element) Expansion Algorithm

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonLdApi

public JsonLdApi()

Constructs an empty JsonLdApi object using the default JsonLdOptions, and without initialization.

JsonLdApi

public JsonLdApi(java.lang.Object input,
                 java.lang.Object context,
                 JsonLdOptions opts)
          throws JsonLdError

Constructs a JsonLdApi object using the given object as the initial JSON-LD object, the given context, and the given JsonLdOptions.

Parameters:

input - The initial JSON-LD object.

context - The initial context.

opts - The JsonLdOptions to use.

Throws:

JsonLdError - If there is an error initializing using the object and options.

Method Detail

compact

public java.lang.Object compact(Context activeCtx,
                                java.lang.String activeProperty,
                                java.lang.Object element,
                                boolean compactArrays)
                         throws JsonLdError

Compaction Algorithm

http://json-ld.org/spec/latest/json-ld-api/#compaction-algorithm

Parameters:

activeCtx - The Active Context

activeProperty - The Active Property

element - The current element

compactArrays - True to compact arrays.

Returns:

The compacted JSON-LD object.

Throws:

JsonLdError - If there was an error during compaction.

compact

public java.lang.Object compact(Context activeCtx,
                                java.lang.String activeProperty,
                                java.lang.Object element)
                         throws JsonLdError

Compaction Algorithm

http://json-ld.org/spec/latest/json-ld-api/#compaction-algorithm

Parameters:

activeCtx - The Active Context

activeProperty - The Active Property

element - The current element

Returns:

The compacted JSON-LD object.

Throws:

JsonLdError - If there was an error during compaction.

expand

public java.lang.Object expand(Context activeCtx,
                               java.lang.String activeProperty,
                               java.lang.Object element)
                        throws JsonLdError

Expansion Algorithm

http://json-ld.org/spec/latest/json-ld-api/#expansion-algorithm

Parameters:

activeCtx - The Active Context

activeProperty - The Active Property

element - The current element

Returns:

The expanded JSON-LD object.

Throws:

JsonLdError - If there was an error during expansion.

expand

public java.lang.Object expand(Context activeCtx,
                               java.lang.Object element)
                        throws JsonLdError

Expansion Algorithm

http://json-ld.org/spec/latest/json-ld-api/#expansion-algorithm

Parameters:

activeCtx - The Active Context

element - The current element

Returns:

The expanded JSON-LD object.

Throws:

JsonLdError - If there was an error during expansion.