forked from jsonld-java/jsonld-java
-
Notifications
You must be signed in to change notification settings - Fork 0
/
JSONLDProcessor.java
3889 lines (3433 loc) · 146 KB
/
JSONLDProcessor.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package com.github.jsonldjava.core;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.text.DecimalFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.github.jsonldjava.impl.NQuadTripleCallback;
import com.github.jsonldjava.utils.JSONUtils;
import com.github.jsonldjava.utils.Obj;
public class JSONLDProcessor {
private static final Logger LOG = LoggerFactory.getLogger(JSONLDProcessor.class);
// constants
private static final String XSD_BOOLEAN = "http://www.w3.org/2001/XMLSchema#boolean";
private static final String XSD_DOUBLE = "http://www.w3.org/2001/XMLSchema#double";
private static final String XSD_INTEGER = "http://www.w3.org/2001/XMLSchema#integer";
private static final String XSD_STRING = "http://www.w3.org/2001/XMLSchema#string";
private static final String RDF = "http://www.w3.org/1999/02/22-rdf-syntax-ns#";
private static final String RDF_FIRST = RDF + "first";
private static final String RDF_REST = RDF + "rest";
private static final String RDF_NIL = RDF + "nil";
private static final String RDF_TYPE = RDF + "type";
private static final String RDF_PLAIN_LITERAL = RDF + "PlainLiteral";
private static final String RDF_XML_LITERAL = RDF + "XMLLiteral";
private static final String RDF_OBJECT = RDF + "object";
private Map<String, Object> edges;
private Map<String, Object> subjects;
private Map<String, Object> renamed;
private Map<String, Object> serializations;
public static class Options {
public Options() {
this.base = "";
this.strict = true;
}
public Options(String base) {
this.base = base;
this.strict = true;
}
public Options(String base, Boolean strict) {
this.base = base;
this.strict = strict;
}
public String base = null;
public Boolean strict = null;
public Boolean graph = null;
public Boolean optimize = null;
public Map<String, Object> optimizeCtx = null;
public Boolean embed = null;
public Boolean explicit = null;
public Boolean omitDefault = null;
public Boolean collate = null;
public Boolean useRdfType = null;
public Boolean useNativeTypes = null;
private Set<String> ignoredKeys = new HashSet<String>();
// custom option to give to expand and compact which will generate @id's for elements that don't
// have a specific @id
public Boolean addBlankNodeIDs = false;
/**
* Tells the processor to skip over the key specified by "key" any time it encounters it. Objects under this key will not be manipulated by any of the
* processor functions and no triples will be created using it.
*
* @param key
* The name of the key this processor should ignore.
*/
public Options ignoreKey(String key) {
ignoredKeys.add(key);
return this;
}
public Boolean isIgnored(String key) {
return ignoredKeys.contains(key);
}
public Options clone() {
Options rval = new Options(base);
rval.strict = strict;
rval.graph = graph;
rval.optimize = optimize;
rval.optimizeCtx = (Map<String, Object>) JSONLDUtils.clone(optimizeCtx);
rval.embed = embed;
rval.explicit = explicit;
rval.omitDefault = omitDefault;
rval.collate = collate;
rval.useNativeTypes = useNativeTypes;
rval.useRdfType = useRdfType;
rval.addBlankNodeIDs = addBlankNodeIDs;
for (String key: ignoredKeys) {
rval.ignoreKey(key);
}
return rval;
}
}
Options opts;
public JSONLDProcessor() {
opts = new Options("");
}
public JSONLDProcessor(Options opts) {
if (opts == null) {
opts = new Options("");
} else {
this.opts = opts;
}
}
/**
* A helper class which still stores all the values in a map
* but gives member variables easily access certain keys
*
* @author tristan
*
*/
public class ActiveContext extends HashMap<String, Object> {
public ActiveContext() {
super();
init();
}
public ActiveContext(Map<String,Object> copy) {
super(copy);
init();
}
private void init() {
if (!this.containsKey("mappings")) {
this.put("mappings", new HashMap<String,Object>());
}
if (!this.containsKey("keywords")) {
this.put("keywords", new HashMap<String, List<String>>() {
{
put("@context", new ArrayList<String>());
put("@container", new ArrayList<String>());
put("@default", new ArrayList<String>());
put("@embed", new ArrayList<String>());
put("@explicit", new ArrayList<String>());
put("@graph", new ArrayList<String>());
put("@id", new ArrayList<String>());
put("@language", new ArrayList<String>());
put("@list", new ArrayList<String>());
put("@omitDefault", new ArrayList<String>());
put("@preserve", new ArrayList<String>());
put("@set", new ArrayList<String>());
put("@type", new ArrayList<String>());
put("@value", new ArrayList<String>());
put("@vocab", new ArrayList<String>());
// add ignored keywords
/*
for (String key : ignoredKeywords) {
put(keyword, new ArrayList<String>());
}
*/
}
});
}
mappings = (Map<String, Object>) this.get("mappings");
keywords = (Map<String, List<String>>) this.get("keywords");
}
public Object getContextValue(String key, String type) {
if (key == null) {
return null;
}
Object rval = null;
if ("@language".equals(type) && this.containsKey(type)) {
rval = this.get(type);
}
if (this.mappings.containsKey(key)) {
Map<String, Object> entry = (Map<String, Object>) this.mappings.get(key);
if (type == null) {
rval = entry;
} else if (entry.containsKey(type)) {
rval = entry.get(type);
}
}
return rval;
}
public Map<String, Object> mappings;
public Map<String, List<String>> keywords;
}
public class UniqueNamer {
private String prefix;
private int counter;
private HashMap<String, String> existing;
/**
* Creates a new UniqueNamer. A UniqueNamer issues unique names, keeping
* track of any previously issued names.
*
* @param prefix the prefix to use ('<prefix><counter>').
*/
public UniqueNamer(String prefix) {
this.prefix = prefix;
this.counter = 0;
this.existing = new HashMap<String,String>();
}
/**
* Copies this UniqueNamer.
*
* @return a copy of this UniqueNamer.
*/
public UniqueNamer clone() {
UniqueNamer copy = new UniqueNamer(this.prefix);
copy.counter = this.counter;
copy.existing = (HashMap<String, String>) JSONLDUtils.clone(this.existing);
return copy;
}
/**
* Gets the new name for the given old name, where if no old name is given
* a new name will be generated.
*
* @param [oldName] the old name to get the new name for.
*
* @return the new name.
*/
public String getName(String oldName) {
if (oldName != null && this.existing.containsKey(oldName)) {
return this.existing.get(oldName);
}
String name = this.prefix + this.counter;
this.counter++;
if (oldName != null) {
this.existing.put(oldName, name);
}
return name;
}
public String getName() {
return getName(null);
}
public Boolean isNamed(String oldName) {
return this.existing.containsKey(oldName);
}
}
/**
* Defines a context mapping during context processing.
*
* @param activeCtx the current active context.
* @param ctx the local context being processed.
* @param key the key in the local context to define the mapping for.
* @param base the base IRI.
* @param defined a map of defining/defined keys to detect cycles and prevent
* double definitions.
* @throws JSONLDProcessingError
*/
private void defineContextMapping(ActiveContext activeCtx, Map<String, Object> ctx, String key, String base, Map<String, Boolean> defined) throws JSONLDProcessingError {
if (defined.containsKey(key)) {
// key already defined
if (defined.get(key) == Boolean.TRUE) {
return;
}
// cycle detected
throw new JSONLDProcessingError("Cyclical context definition detected")
.setDetail("context", ctx)
.setDetail("key", key);
}
// now defining key
defined.put(key, Boolean.FALSE);
// if key has a prefix, define it first
String prefix = null;
int colon = key.indexOf(":");
if (colon != -1) {
prefix = key.substring(0, colon);
if (ctx.containsKey(prefix)) {
// define parent prefix
defineContextMapping(activeCtx, ctx, prefix, base, defined);
}
}
// get context key value
Object value = ctx.get(key);
if (JSONLDUtils.isKeyword(key)) {
// support @vocab
if ("@vocab".equals(key)) {
if (!value.equals(null) && !(value instanceof String)) {
throw new JSONLDProcessingError("Invalid JSON-LD syntax; the value of \"@vocab\" in a @context must be a string or null.")
.setType(JSONLDProcessingError.Error.SYNTAX_ERROR)
.setDetail("context", ctx);
}
if (((String)value).indexOf(":") == -1) {
throw new JSONLDProcessingError("Invalid JSON-LD syntax; the value of \"@vocab\" in a @context must be an absolute IRI.")
.setType(JSONLDProcessingError.Error.SYNTAX_ERROR)
.setDetail("context", ctx);
}
if (value == null) {
activeCtx.remove("@vocab");
} else {
activeCtx.put("@vocab", value);
}
defined.put(key, Boolean.TRUE);
return;
}
// only @language is permitted
if (!"@language".equals(key)) {
throw new JSONLDProcessingError("Invalid JSON-LD syntax; keywords cannot be overridden")
.setType(JSONLDProcessingError.Error.SYNTAX_ERROR)
.setDetail("context", ctx);
}
if (!value.equals(null) && !(value instanceof String)) {
throw new JSONLDProcessingError("Invalid JSON-LD syntax; the value of \"@language\" in a @context must be a string or null")
.setType(JSONLDProcessingError.Error.SYNTAX_ERROR)
.setDetail("context", ctx);
}
if (value == null) {
activeCtx.remove("@language");
} else {
activeCtx.put("@language", value);
}
defined.put(key, Boolean.TRUE);
return;
}
// clear context entry
if (value == null || (value instanceof Map && ((Map<String, Object>) value).containsKey("@id") && ((Map<String, Object>) value).get("@id") == null)) {
if (activeCtx.mappings.containsKey(key)) {
// if key is a keyword alias, remove it
String kw = (String) ((Map<String, Object>) activeCtx.mappings.get(key)).get("@id");
if (JSONLDUtils.isKeyword(kw)) {
List<String> aliases = activeCtx.keywords.get(kw);
aliases.remove(key);
}
activeCtx.mappings.remove(key);
}
defined.put(key, Boolean.TRUE);
return;
}
if (value instanceof String) {
if (JSONLDUtils.isKeyword((String) value)) {
// disallow aliasing @context and @preserve
if ("@context".equals(value) || "@preserve".equals(value)) {
throw new JSONLDProcessingError("Invalid JSON-LD syntax; @context and @preserve cannot be aliased")
.setType(JSONLDProcessingError.Error.SYNTAX_ERROR);
}
// uniquely add key as a keyword alias and resort
List<String> aliases = activeCtx.keywords.get(value);
if (!aliases.contains(key)) {
aliases.add(key);
Collections.sort(aliases, new Comparator<String>() {
// Compares two strings first based on length and then lexicographically
public int compare(String a, String b) {
if (a.length() < b.length()) {
return -1;
} else if (b.length() < a.length()) {
return 1;
}
return a.compareTo(b);
}
});
}
} else {
// expand value to a full IRI
value = expandContextIri(activeCtx, ctx, (String) value, base, defined);
}
// define/redefine key to expanded IRI/keyword
Map<String, Object> tmp = new HashMap<String, Object>();
tmp.put("@id", value);
activeCtx.mappings.put(key, tmp);
defined.put(key, Boolean.TRUE);
return;
}
if (!(value instanceof Map)) {
throw new JSONLDProcessingError("Invalid JSON-LD syntax; @context property values must be strings or objects.")
.setType(JSONLDProcessingError.Error.SYNTAX_ERROR)
.setDetail("context", ctx);
}
// create new mapping
Map<String, Object> mapping = new HashMap<String, Object>();
// helper to make accessing the value as a map easier
Map<String, Object> val = (Map<String, Object>) value;
if (val.containsKey("@id")) {
if (!(val.get("@id") instanceof String)) {
throw new JSONLDProcessingError("Invalid JSON-LD syntax; @context @id values must be strings.")
.setType(JSONLDProcessingError.Error.SYNTAX_ERROR)
.setDetail("context", ctx);
}
String id = (String) val.get("@id");
// expand @id if it is not @type
if (!"@type".equals(id)) {
// expand @id to full IRI
id = expandContextIri(activeCtx, ctx, id, base, defined);
}
// add @id to mapping
mapping.put("@id", id);
} else if (activeCtx.containsKey("@vocab") && activeCtx.get("@vocab") != null) {
// NOTE: this is not implemented in javascript (which actually fails tests that need it)
String id = activeCtx.get("@vocab") + key;
mapping.put("@id", id);
} else {
// non-IRIs *must* define @ids
if (prefix == null) {
throw new JSONLDProcessingError("Invalid JSON-LD syntax; @context terms must define an @id.")
.setType(JSONLDProcessingError.Error.SYNTAX_ERROR)
.setDetail("context", ctx)
.setDetail("key", val);
}
if (activeCtx.mappings.containsKey(prefix)) {
String suffix = key.substring(colon + 1);
mapping.put("@id", (String) ((Map<String, Object>) activeCtx.mappings.get(prefix)).get("@id") + suffix);
} else {
mapping.put("@id", key);
}
}
if (val.containsKey("@type")) {
if (!(val.get("@type") instanceof String)) {
throw new JSONLDProcessingError("Invalid JSON-LD syntax; @context @type values must be strings.")
.setType(JSONLDProcessingError.Error.SYNTAX_ERROR)
.setDetail("context", ctx);
}
String type = (String) val.get("@type");
if (!"@id".equals(type)) {
// expand @type to full IRI
type = expandContextIri(activeCtx, ctx, type, null, defined);
}
// add @type to mapping
mapping.put("@type", type);
}
if (val.containsKey("@container")) {
Object container = val.get("@container");
if (!("@list".equals(container) || "@set".equals(container) || "@language".equals(container))) {
throw new JSONLDProcessingError("Invalid JSON-LD syntax; @context @container value must be \"@list\" or \"@set\".")
.setType(JSONLDProcessingError.Error.SYNTAX_ERROR)
.setDetail("context", ctx);
}
// add @container to mapping
mapping.put("@container", container);
}
if (val.containsKey("@language")) {
Object lang = val.get("@language");
if (lang != null && !(lang instanceof String)) {
throw new JSONLDProcessingError("Invalid JSON-LD syntax; @context @language must be a string or null.")
.setType(JSONLDProcessingError.Error.SYNTAX_ERROR)
.setDetail("context", ctx);
}
// add @language to mapping
mapping.put("@language", lang);
}
// merge onto parent mapping if one exists for a prefix
if (prefix != null && activeCtx.mappings.containsKey(prefix)) {
Map<String, Object> child = mapping;
mapping = (Map<String, Object>) JSONLDUtils.clone(activeCtx.mappings.get(prefix));
for (String k : child.keySet()) {
mapping.put(k, child.get(k));
}
}
// define key mapping
activeCtx.mappings.put(key, mapping);
defined.put(key, Boolean.TRUE);
}
/**
* Expands a string value to a full IRI during context processing. It can
* be assumed that the value is not a keyword.
*
* @param activeCtx the current active context.
* @param ctx the local context being processed.
* @param value the string value to expand.
* @param base the base IRI.
* @param defined a map for tracking cycles in context definitions.
*
* @return the expanded value.
* @throws JSONLDProcessingError
*/
private String expandContextIri(ActiveContext activeCtx, Map<String, Object> ctx, String value, String base, Map<String, Boolean> defined) throws JSONLDProcessingError {
// dependency not defined, define it
if (ctx.containsKey(value) && defined.get(value) != Boolean.TRUE) {
defineContextMapping(activeCtx, ctx, value, base, defined);
}
// recurse if value is a term
if (activeCtx.mappings.containsKey(value)) {
String id = ((Map<String, String>) activeCtx.mappings.get(value)).get("@id");
// value is already an absolute IRI
if (id != null && id.equals(value)) {
return value;
}
return expandContextIri(activeCtx, ctx, id, base, defined);
}
// split value into prefix:suffix
int colon = value.indexOf(':');
if (colon != -1) {
String prefix = value.substring(0, colon);
String suffix = value.substring(colon + 1);
// indicates the value is a blank node
if ("_".equals(prefix)) {
return value;
}
// indicates the value is an absolute IRI
if (suffix.startsWith("//")) {
return value;
}
// dependency not defined, define it
if (ctx.containsKey(prefix) && defined.get(prefix) != Boolean.TRUE) {
defineContextMapping(activeCtx, ctx, prefix, base, defined);
}
// recurse if prefix is defined
if (activeCtx.mappings.containsKey(prefix)) {
String id = ((Map<String, String>) activeCtx.mappings.get(prefix)).get("@id");
return expandContextIri(activeCtx, ctx, id, base, defined) + suffix;
}
// consider the value an absolute IRI
return value;
}
if (JSONLDUtils.isKeyword(value)) {
}
// prepend vocab
else if (base == null && ctx.containsKey("@vocab")) {
value = prependBaseAndnormalizeURI((String)ctx.get("@vocab"), value);
} else if (base != null && activeCtx.containsKey("@vocab")) {
// NOTE: this fulfills the case where @vocab is in the root of the active content
// which from the expected results of test compact-0021 is required to be used
// over the value of base
value = prependBaseAndnormalizeURI((String)activeCtx.get("@vocab"), value);
} else if (base != null) {
value = prependBaseAndnormalizeURI(base, value);
}
// value must now be an absolute IRI
if (!JSONLDUtils.isAbsoluteIri(value)) {
throw new JSONLDProcessingError("Invalid JSON-LD syntax; a @context value does not expand to an absolute IRI.")
.setType(JSONLDProcessingError.Error.SYNTAX_ERROR)
.setDetail("context", ctx)
.setDetail("value", value);
}
return value;
}
/**
* Processes a local context, resolving any URLs as necessary, and returns a
* new active context in its callback.
*
* @param activeCtx the current active context.
* @param localCtx the local context to process.
* @param [options] the options to use:
* [resolver(url, callback(err, jsonCtx))] the URL resolver to use.
* @param callback(err, ctx) called once the operation completes.
* @throws JSONLDProcessingError
*/
public ActiveContext processContext(ActiveContext activeCtx, Object localCtx) throws JSONLDProcessingError {
// initialize the resulting context
ActiveContext rval = (ActiveContext) JSONLDUtils.clone(activeCtx);
// normalize local context to an array of @context objects
if (localCtx instanceof Map && ((Map) localCtx).containsKey("@context") && ((Map) localCtx).get("@context") instanceof List) {
localCtx = ((Map) localCtx).get("@context");
}
List<Map<String, Object>> ctxs;
if (localCtx instanceof List) {
ctxs = (List<Map<String, Object>>) localCtx;
} else {
ctxs = new ArrayList<Map<String, Object>>();
ctxs.add((Map<String, Object>) localCtx);
}
// process each context in order
for (Object ctx : ctxs) {
if (ctx == null) {
// reset to initial context
rval = new ActiveContext();
continue;
}
// context must be an object by now, all URLs resolved before this call
if (ctx instanceof Map) {
// dereference @context key if present
if (((Map<String, Object>) ctx).containsKey("@context")) {
ctx = (Map<String, Object>) ((Map<String, Object>) ctx).get("@context");
}
// define context mappings for keys in local context
HashMap<String, Boolean> defined = new HashMap<String, Boolean>();
for (String key : ((Map<String, Object>) ctx).keySet()) {
defineContextMapping(rval, (Map<String, Object>) ctx, key, opts.base, defined);
}
} else {
// context must be an object by now, all URLs resolved before this call
throw new JSONLDProcessingError("@context must be an object")
.setType(JSONLDProcessingError.Error.SYNTAX_ERROR)
.setDetail("context", ctx);
}
}
return rval;
}
/**
* Processes a local context and returns a new active context.
*
* @param activeCtx the current active context.
* @param localCtx the local context to process.
* @param options the context processing options.
*
* @return the new active context.
* @throws JSONLDProcessingError
*/
public static ActiveContext processContext(ActiveContext activeCtx, Object localCtx, Options opts) throws JSONLDProcessingError {
JSONLDProcessor p = new JSONLDProcessor(opts);
if (localCtx == null) {
return p.new ActiveContext();
}
localCtx = JSONLDUtils.clone(localCtx);
if (localCtx instanceof Map && !((Map) localCtx).containsKey("@context")) {
Map<String, Object> tmp = new HashMap<String, Object>();
tmp.put("@context", localCtx);
localCtx = tmp;
}
return p.processContext(activeCtx, localCtx);
}
/**
* Expands a term into an absolute IRI. The term may be a regular term, a
* prefix, a relative IRI, or an absolute IRI. In any case, the associated
* absolute IRI will be returned.
*
* @param ctx the active context to use.
* @param term the term to expand.
* @param base the base IRI to use if a relative IRI is detected.
*
* @return the expanded term as an absolute IRI.
*/
private String expandTerm(ActiveContext ctx, String term, String base) {
return expandTerm(ctx, term, base, false, false);
}
// NOTE: adding isKey and isValueOfType flags to support points 4.3.5/6
private String expandTerm(ActiveContext ctx, String term, String base, Boolean isKey, Boolean isValueOfType) {
// nothing to expand
if (term == null) {
return null;
}
// the term has a mapping, so it is a plain term
if (ctx.mappings.containsKey(term)) {
String id = (String) ((Map<String, Object>) ctx.mappings.get(term)).get("@id");
// term is already an absolute IRI
if (term.equals(id)) {
return term;
}
return expandTerm(ctx, id, base);
}
// split term into prefix:suffix
int colon = term.indexOf(':');
if (colon != -1) {
String prefix = term.substring(0, colon);
String suffix = term.substring(colon + 1);
// indicates the value is a blank node
if ("_".equals(prefix)) {
return term;
}
// indicates the value is an absolute IRI
if (suffix.startsWith("//")) {
return term;
}
// the term's prefix has a mapping, so it is a CURIE
if (ctx.mappings.containsKey(prefix)) {
return expandTerm(ctx, (String) ((Map<String, Object>) ctx.mappings.get(prefix)).get("@id"), base) + suffix;
}
// consider term an absolute IRI
return term;
}
// TODO: 5) Otherwise, if the IRI being processed does not contain a colon and is a property,
// i.e., a key in a JSON object, or the value of @type and the active context has a @vocab
// mapping, join the mapped value to the suffix using textual concatenation.
// TODO: this seems to be missing a check to see if this is a keyword
if (JSONLDUtils.isKeyword(term)) {
// then we just return the term
}
// use vocab // TODO: added base check, since terms that are not key's or values of @type should prioritise base before @vocab
else if ((isKey || isValueOfType) && ctx.containsKey("@vocab")) {
term = prependBaseAndnormalizeURI((String) ctx.get("@vocab"), term);
// prepend base to term
} else if (!isKey && base != null) {
term = prependBaseAndnormalizeURI(base, term);
}
return term;
}
/**
* prepends the iri to the base uri and normalizes that URI
*
* @param base
* @param iri
* @return the new normalized uri or the original iri if base is not a valid uri
*/
private String prependBaseAndnormalizeURI(String base, String iri) {
try {
URI b = new URI(base);
URI rval;
// URI.resolve does not handle query strings, bases ending with # or empty iris correctly
if (iri.startsWith("?") || base.endsWith("#") || "".equals(iri)) {
rval = new URI(base + iri);
} else {
rval = b.resolve(iri);
}
rval = rval.normalize();
// check if there are ./ or ../ still in the uri path, and if so normalize manually (as java doesn't handle excessive ../ correctly
if (rval.getPath().contains("./")) {
List<String> pathelems = new ArrayList<String>(Arrays.asList(rval.getPath().split("/")));
String tmp; // used to force remove (int)
for (int i = 0; i < pathelems.size(); i++) {
if (".".equals(pathelems.get(i))) {
tmp = pathelems.remove(i);
--i;
} else if ("..".equals(pathelems.get(i))) {
tmp = pathelems.remove(i);
// make sure we don't remove the first element ""
if (i > 1) {
tmp = pathelems.remove(i-1);
i =- 2;
} else {
--i;
}
}
}
String path = "";
for (String p: pathelems) {
path += p + "/";
}
if (!rval.getPath().endsWith("/")) {
path = path.substring(0, path.length()-1); // remove trailing / if the original path doesn't end with one
}
rval = rval.resolve(path);
}
return rval.toString();
} catch (URISyntaxException e) {
// if we have an error here just ignore it and return the unmodified IRI
return iri;
}
}
private String expandTerm(ActiveContext ctx, String term) {
return expandTerm(ctx, term, null);
}
/**
* Expands the given value by using the coercion and keyword rules in the
* given context.
*
* @param ctx the active context to use.
* @param property the property the value is associated with.
* @param value the value to expand.
* @param base the base IRI to use.
*
* @return the expanded value.
*/
private Object expandValue(ActiveContext ctx, String property, Object value, String base) {
// nothing to expand
if (value == null) {
return null;
}
// default to simple string return value
Object rval = value;
// special-case expand @id and @type (skips '@id' expansion)
String prop = expandTerm(ctx, property, base, true, false);
if ("@id".equals(prop)) {
rval = expandTerm(ctx, (String) value, base, false, false);
} else if ("@type".equals(prop)) {
rval = expandTerm(ctx, (String) value, base, false, true);
} else {
// get type definition from context
Object type = ctx.getContextValue(property, "@type");
// do @id expansion (automatic for @graph)
if ("@id".equals(type) || "@graph".equals(prop)) {
Map<String, Object> tmp = new HashMap<String, Object>();
tmp.put("@id", expandTerm(ctx, (String) value, base));
rval = tmp;
} else if (!JSONLDUtils.isKeyword(prop)) {
Map<String, Object> tmp = new HashMap<String, Object>();
tmp.put("@value", value);
rval = tmp;
// other type
if (type != null) {
tmp.put("@type", type);
// check for language tagging
} else {
Object language = ctx.getContextValue(property, "@language");
if (language != null) {
tmp.put("@language", language);
}
}
}
}
return rval;
}
/**
* Throws an exception if the given value is not a valid @type value.
*
* @param v the value to check.
* @throws JSONLDProcessingError
*/
private boolean validateTypeValue(Object v) throws JSONLDProcessingError {
// must be a string, subject reference, or empty object
if (v instanceof String || (v instanceof Map && (((Map<String, Object>) v).containsKey("@id") || ((Map<String, Object>) v).size() == 0))) {
return true;
}
// must be an array
boolean isValid = false;
if (v instanceof List) {
isValid = true;
for (Object i : (List) v) {
if (!(i instanceof String || i instanceof Map && ((Map<String, Object>) i).containsKey("@id"))) {
isValid = false;
break;
}
}
}
if (!isValid) {
throw new JSONLDProcessingError(
"Invalid JSON-LD syntax; \"@type\" value must a string, a subject reference, an array of strings or subject references, or an empty object.")
.setType(JSONLDProcessingError.Error.SYNTAX_ERROR)
.setDetail("value", v);
}
return true;
}
/**
* Compacts an IRI or keyword into a term or prefix if it can be. If the
* IRI has an associated value it may be passed.
*
* @param ctx the active context to use.
* @param iri the IRI to compact.
* @param value the value to check or null.
* @param isKey if this is a key in the object map, or a value of @type
*
* @return the compacted term, prefix, keyword alias, or the original IRI.
*/
public static String compactIri(ActiveContext ctx, String iri, Object value, boolean isKey) {
// can't compact null
if (iri == null) {
return iri;
}
// term is a keyword
if (JSONLDUtils.isKeyword(iri)) {
// return alias if available
List<String> aliases = ctx.keywords.get(iri);
if (aliases.size() > 0) {
return aliases.get(0);
} else {
// no alias, keep original keyword
return iri;
}
}
// default value to null
// NOTE: since there is no 'undefined' in Java, there's nothing to do here
// find all possible term matches
List<String> terms = new ArrayList<String>();
int highest = 0;
boolean listContainer = false;
boolean isList = (value instanceof Map && ((Map<String, Object>) value).containsKey("@list"));
for (String term : ctx.mappings.keySet()) {
// skip terms with non-matching iris
Map<String, Object> entry = (Map<String, Object>) ctx.mappings.get(term);
if (!iri.equals(entry.get("@id"))) {
continue;
}
// skip @set containers for @lists
if (isList && "@set".equals(entry.get("@container"))) {
continue;
}
// skip @list containers for non-@lists
if (!isList && "@list".equals(entry.get("@container")) && value != null) {
continue;
}
// for @lists, if listContainer is set, skip non-list containers
if (isList && listContainer && !"@list".equals(entry.get("@container"))) {
continue;
}
// rank term
int rank = rankTerm(ctx, term, value);
if (rank > 0) {
// add 1 to rank if container is a @set
if ("@set".equals(entry.get("@container"))) {
rank += 1;
}
// for @lists, give preference to @list containers
if (isList && !listContainer && "@list".equals(entry.get("@container"))) {
listContainer = true;
terms.clear();
highest = rank;
terms.add(term);
// only push match if rank meets current threshold
} else if (rank >= highest) {
if (rank > highest) {
terms.clear();
highest = rank;
}
terms.add(term);
}
}
}
// if this is a key or the value of @type, compact with @vocab first
// otherwise do it the otherway around
// NOTE: this helps to satisfy test compact-0021
// TODO: remove duplicate code
if (isKey) {
// NOTE: added this after the check for CURRIES to support test compact-0021
// no matching terms, use @vocab if available
if (terms.size() == 0 && ctx.containsKey("@vocab")) {
// determine if vocab is a prefix of the iri
String vocab = (String) ctx.get("@vocab");
if (iri.startsWith(vocab)) {
// use suffix as relative iri if it is not a term in the active context
String suffix = iri.substring(vocab.length());
if (!ctx.mappings.containsKey(suffix)) {