XmlAssemblyInstance.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.xml;
import gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine;
import gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline;
import gov.nist.secauto.metaschema.core.model.AbstractAssemblyInstance;
import gov.nist.secauto.metaschema.core.model.IAssemblyDefinition;
import gov.nist.secauto.metaschema.core.model.IModelContainer;
import gov.nist.secauto.metaschema.core.model.JsonGroupAsBehavior;
import gov.nist.secauto.metaschema.core.model.XmlGroupAsBehavior;
import gov.nist.secauto.metaschema.core.model.xml.xmlbeans.AssemblyReferenceType;
import gov.nist.secauto.metaschema.core.model.xml.xmlbeans.MarkupLineDatatype;
import gov.nist.secauto.metaschema.core.util.CollectionUtil;
import gov.nist.secauto.metaschema.core.util.ObjectUtils;
import java.util.Collection;
import java.util.Collections;
import java.util.Map;
import java.util.Set;
import javax.xml.namespace.QName;
import edu.umd.cs.findbugs.annotations.NonNull;
class XmlAssemblyInstance
extends AbstractAssemblyInstance {
// private static final Logger logger =
// LogManager.getLogger(XmlAssemblyInstance.class);
private final AssemblyReferenceType xmlAssembly;
/**
* Constructs a new Metaschema Assembly instance definition from an XML
* representation bound to Java objects.
*
* @param xmlAssembly
* the XML representation bound to Java objects
* @param parent
* the parent container, either a choice or assembly
*/
public XmlAssemblyInstance(
@NonNull AssemblyReferenceType xmlAssembly,
@NonNull IModelContainer parent) {
super(parent);
this.xmlAssembly = xmlAssembly;
}
/**
* Get the underlying XML data.
*
* @return the underlying XML data
*/
protected AssemblyReferenceType getXmlAssembly() {
return xmlAssembly;
}
@Override
public IAssemblyDefinition getDefinition() {
// This will always be not null
return ObjectUtils.notNull(getContainingModule()
.getScopedAssemblyDefinitionByName(getName()));
}
@Override
public String getFormalName() {
return getXmlAssembly().isSetFormalName() ? getXmlAssembly().getFormalName() : null;
}
@Override
public Map<QName, Set<String>> getProperties() {
return ModelFactory.toProperties(CollectionUtil.listOrEmpty(getXmlAssembly().getPropList()));
}
@Override
public MarkupLine getDescription() {
MarkupLine retval = null;
if (getXmlAssembly().isSetDescription()) {
MarkupLineDatatype description = getXmlAssembly().getDescription();
assert description != null;
retval = MarkupStringConverter.toMarkupString(description);
}
return retval;
}
@SuppressWarnings("null")
@Override
public String getName() {
return getXmlAssembly().getRef();
}
@Override
public String getUseName() {
return getXmlAssembly().isSetUseName() ? getXmlAssembly().getUseName() : null;
}
@Override
public String getGroupAsName() {
return getXmlAssembly().isSetGroupAs() ? getXmlAssembly().getGroupAs().getName() : null;
}
@Override
public int getMinOccurs() {
return XmlModelParser.getMinOccurs(getXmlAssembly().getMinOccurs());
}
@Override
public int getMaxOccurs() {
return XmlModelParser.getMaxOccurs(getXmlAssembly().getMaxOccurs());
}
@Override
public JsonGroupAsBehavior getJsonGroupAsBehavior() {
return XmlModelParser.getJsonGroupAsBehavior(getXmlAssembly().getGroupAs());
}
@Override
public XmlGroupAsBehavior getXmlGroupAsBehavior() {
return XmlModelParser.getXmlGroupAsBehavior(getXmlAssembly().getGroupAs());
}
@SuppressWarnings("null")
@Override
public MarkupMultiline getRemarks() {
return getXmlAssembly().isSetRemarks() ? MarkupStringConverter.toMarkupString(getXmlAssembly().getRemarks()) : null;
}
@Override
public Object getValue(@NonNull Object parentInstance) {
// there is no value
return null;
}
@SuppressWarnings("null")
@Override
public Collection<?> getItemValues(Object instanceValue) {
// there are no item values
return Collections.emptyList();
}
}