1 /*
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.metaschema.core.metapath.format;
28
29 import gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem;
30 import gov.nist.secauto.metaschema.core.metapath.item.node.IDocumentNodeItem;
31 import gov.nist.secauto.metaschema.core.metapath.item.node.IFieldNodeItem;
32 import gov.nist.secauto.metaschema.core.metapath.item.node.IFlagNodeItem;
33 import gov.nist.secauto.metaschema.core.metapath.item.node.IModelNodeItem;
34 import gov.nist.secauto.metaschema.core.metapath.item.node.IModuleNodeItem;
35 import gov.nist.secauto.metaschema.core.metapath.item.node.INodeItem;
36 import gov.nist.secauto.metaschema.core.metapath.item.node.IRootAssemblyNodeItem;
37
38 import edu.umd.cs.findbugs.annotations.NonNull;
39
40 /**
41 * An {@link IPathFormatter} that produces a Metapath expression for the path to
42 * a given {@link INodeItem}.
43 */
44 public class MetapathFormatter implements IPathFormatter {
45
46 @Override
47 public @NonNull String formatMetaschema(IModuleNodeItem metaschema) {
48 // this will result in a slash being generated using the join in the format
49 // method
50 return "";
51 }
52
53 @Override
54 public String formatDocument(IDocumentNodeItem document) {
55 // this will result in a slash being generated using the join in the format
56 // method
57 return "";
58 }
59
60 @Override
61 public String formatRootAssembly(IRootAssemblyNodeItem root) {
62 return root.getName();
63 }
64
65 @Override
66 public String formatAssembly(IAssemblyNodeItem assembly) {
67 // TODO: does it make sense to use this for an intermediate that has no parent?
68 return formatModelPathSegment(assembly);
69 }
70
71 @Override
72 public String formatField(IFieldNodeItem field) {
73 return formatModelPathSegment(field);
74 }
75
76 @Override
77 public String formatFlag(IFlagNodeItem flag) {
78 return "@" + flag.getName();
79 }
80
81 @SuppressWarnings("null")
82 @NonNull
83 private static String formatModelPathSegment(@NonNull IModelNodeItem<?, ?> item) {
84 StringBuilder builder = new StringBuilder(item.getName())
85 .append('[')
86 .append(item.getPosition())
87 .append(']');
88 return builder.toString();
89 }
90 }