001/*
002 * Portions of this software was developed by employees of the National Institute
003 * of Standards and Technology (NIST), an agency of the Federal Government and is
004 * being made available as a public service. Pursuant to title 17 United States
005 * Code Section 105, works of NIST employees are not subject to copyright
006 * protection in the United States. This software may be subject to foreign
007 * copyright. Permission in the United States and in foreign countries, to the
008 * extent that NIST may hold copyright, to use, copy, modify, create derivative
009 * works, and distribute this software and its documentation without fee is hereby
010 * granted on a non-exclusive basis, provided that this notice and disclaimer
011 * of warranty appears in all copies.
012 *
013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
025 */
026
027package gov.nist.secauto.metaschema.core.metapath.format;
028
029import gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem;
030import gov.nist.secauto.metaschema.core.metapath.item.node.IDocumentNodeItem;
031import gov.nist.secauto.metaschema.core.metapath.item.node.IFieldNodeItem;
032import gov.nist.secauto.metaschema.core.metapath.item.node.IFlagNodeItem;
033import gov.nist.secauto.metaschema.core.metapath.item.node.IModelNodeItem;
034import gov.nist.secauto.metaschema.core.metapath.item.node.IModuleNodeItem;
035import gov.nist.secauto.metaschema.core.metapath.item.node.INodeItem;
036import gov.nist.secauto.metaschema.core.metapath.item.node.IRootAssemblyNodeItem;
037
038import edu.umd.cs.findbugs.annotations.NonNull;
039
040/**
041 * An {@link IPathFormatter} that produces a Metapath expression for the path to
042 * a given {@link INodeItem}.
043 */
044public class MetapathFormatter implements IPathFormatter {
045
046  @Override
047  public @NonNull String formatMetaschema(IModuleNodeItem metaschema) {
048    // this will result in a slash being generated using the join in the format
049    // method
050    return "";
051  }
052
053  @Override
054  public String formatDocument(IDocumentNodeItem document) {
055    // this will result in a slash being generated using the join in the format
056    // method
057    return "";
058  }
059
060  @Override
061  public String formatRootAssembly(IRootAssemblyNodeItem root) {
062    return root.getName();
063  }
064
065  @Override
066  public String formatAssembly(IAssemblyNodeItem assembly) {
067    // TODO: does it make sense to use this for an intermediate that has no parent?
068    return formatModelPathSegment(assembly);
069  }
070
071  @Override
072  public String formatField(IFieldNodeItem field) {
073    return formatModelPathSegment(field);
074  }
075
076  @Override
077  public String formatFlag(IFlagNodeItem flag) {
078    return "@" + flag.getName();
079  }
080
081  @SuppressWarnings("null")
082  @NonNull
083  private static String formatModelPathSegment(@NonNull IModelNodeItem<?, ?> item) {
084    StringBuilder builder = new StringBuilder(item.getName())
085        .append('[')
086        .append(item.getPosition())
087        .append(']');
088    return builder.toString();
089  }
090}