INamedInstance.java
/*
* Portions of this software was developed by employees of the National Institute
* of Standards and Technology (NIST), an agency of the Federal Government and is
* being made available as a public service. Pursuant to title 17 United States
* Code Section 105, works of NIST employees are not subject to copyright
* protection in the United States. This software may be subject to foreign
* copyright. Permission in the United States and in foreign countries, to the
* extent that NIST may hold copyright, to use, copy, modify, create derivative
* works, and distribute this software and its documentation without fee is hereby
* granted on a non-exclusive basis, provided that this notice and disclaimer
* of warranty appears in all copies.
*
* THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
* EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
* THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
* INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
* SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
* SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
* INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
* OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
* CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
* PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
* OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
*/
package gov.nist.secauto.metaschema.core.model;
import gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine;
import javax.xml.namespace.QName;
import edu.umd.cs.findbugs.annotations.NonNull;
/**
* This marker interface indicates that the instance has a flag, field, or
* assembly name associated with it which will be used in JSON/YAML or XML to
* identify the data.
*
*/
public interface INamedInstance extends IInstance, INamedModelElement {
/**
* Retrieve the definition of this instance.
*
* @return the corresponding definition
*/
@NonNull
IDefinition getDefinition();
/**
* Get the XML qualified name to use in XML.
*
* @return the XML qualified name, or {@code null} if there isn't one
*/
default QName getXmlQName() {
return new QName(getXmlNamespace(), getEffectiveName());
}
/**
* Retrieve the XML namespace for this instance.
*
* @return the XML namespace or {@code null} if no namespace is defined
*/
default String getXmlNamespace() {
return getContainingModule().getXmlNamespace().toASCIIString();
}
/**
* Get the current value from the provided {@code parentInstance} object. The
* provided object must be of the type associated with the definition containing
* this property.
*
* @param parentInstance
* the object associated with the definition containing this property
* @return the value if available, or {@code null} otherwise
*/
Object getValue(@NonNull Object parentInstance);
/**
* Generates a "coordinate" string for the provided information element
* instance.
*
* A coordinate consists of the element's:
* <ul>
* <li>containing Metaschema module's short name</li>
* <li>model type</li>
* <li>name</li>
* <li>hash code</li>
* <li>the hash code of the definition</li>
* </ul>
*
* @return the coordinate
*/
@SuppressWarnings("null")
@Override
default String toCoordinates() {
IDefinition definition = getDefinition();
return String.format("%s:%s:%s@%d(%d)",
getContainingDefinition().getContainingModule().getShortName(),
getModelType(),
definition.getName(),
hashCode(),
definition.isInline() ? 0 : definition.hashCode());
}
@Override
@NonNull
default String getEffectiveName() {
String result = getUseName();
if (result == null) {
// fall back to the definition
IDefinition def = getDefinition();
result = def.getEffectiveName();
}
return result;
}
@Override
default String getEffectiveFormalName() {
String result = getFormalName();
return result == null ? getDefinition().getEffectiveFormalName() : result;
}
@Override
default MarkupLine getEffectiveDescription() {
MarkupLine result = getDescription();
return result == null ? getDefinition().getEffectiveDescription() : result;
}
}