com.helger.schematron.pure.model.PSName Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-schematron Show documentation
Show all versions of ph-schematron Show documentation
Library for validating XML documents with Schematron
/**
* Copyright (C) 2014-2020 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.helger.schematron.pure.model;
import java.util.Map;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.CollectionHelper;
import com.helger.commons.collection.impl.CommonsLinkedHashMap;
import com.helger.commons.collection.impl.ICommonsOrderedMap;
import com.helger.commons.string.ToStringGenerator;
import com.helger.schematron.CSchematron;
import com.helger.schematron.CSchematronXML;
import com.helger.schematron.pure.errorhandler.IPSErrorHandler;
import com.helger.xml.microdom.IMicroElement;
import com.helger.xml.microdom.MicroElement;
/**
* A single Schematron name-element.
* Provides the names of nodes from the instance document to allow clearer
* assertions and diagnostics. The optional path attribute is an expression
* evaluated in the current context that returns a string that is the name of a
* node. In the latter case, the name of the node is used.
* An implementation which does not report natural-language assertions is not
* required to make use of this element.
*
* @author Philip Helger
*/
@NotThreadSafe
public class PSName implements IPSClonableElement , IPSHasForeignAttributes
{
private String m_sPath;
private ICommonsOrderedMap m_aForeignAttrs;
public PSName ()
{}
public boolean isValid (@Nonnull final IPSErrorHandler aErrorHandler)
{
return true;
}
public void validateCompletely (@Nonnull final IPSErrorHandler aErrorHandler)
{
// Nothing to do
}
public boolean isMinimal ()
{
return true;
}
public void addForeignAttribute (@Nonnull final String sAttrName, @Nonnull final String sAttrValue)
{
ValueEnforcer.notNull (sAttrName, "AttrName");
ValueEnforcer.notNull (sAttrValue, "AttrValue");
if (m_aForeignAttrs == null)
m_aForeignAttrs = new CommonsLinkedHashMap <> ();
m_aForeignAttrs.put (sAttrName, sAttrValue);
}
public boolean hasForeignAttributes ()
{
return m_aForeignAttrs != null && m_aForeignAttrs.isNotEmpty ();
}
@Nonnull
@ReturnsMutableCopy
public ICommonsOrderedMap getAllForeignAttributes ()
{
return new CommonsLinkedHashMap <> (m_aForeignAttrs);
}
/**
* @param sPath
* The path to use. May be null
.
*/
public void setPath (@Nullable final String sPath)
{
m_sPath = sPath;
}
/**
* @return true
if a path is specified, false
* otherwise.
*/
public boolean hasPath ()
{
return m_sPath != null;
}
/**
* @return The optional path to use.
*/
@Nullable
public String getPath ()
{
return m_sPath;
}
@Nonnull
public IMicroElement getAsMicroElement ()
{
final IMicroElement ret = new MicroElement (CSchematron.NAMESPACE_SCHEMATRON, CSchematronXML.ELEMENT_NAME);
ret.setAttribute (CSchematronXML.ATTR_PATH, m_sPath);
if (m_aForeignAttrs != null)
for (final Map.Entry aEntry : m_aForeignAttrs.entrySet ())
ret.setAttribute (aEntry.getKey (), aEntry.getValue ());
return ret;
}
@Nonnull
public PSName getClone ()
{
final PSName ret = new PSName ();
ret.setPath (m_sPath);
if (hasForeignAttributes ())
ret.addForeignAttributes (m_aForeignAttrs);
return ret;
}
@Override
public String toString ()
{
return new ToStringGenerator (this).appendIfNotNull ("path", m_sPath)
.appendIf ("foreignAttrs", m_aForeignAttrs, CollectionHelper::isNotEmpty)
.getToString ();
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy