All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.helger.schematron.pure.model.PSSpan Maven / Gradle / Ivy

There is a newer version: 5.6.5
Show newest version
/**
 * Copyright (C) 2014-2017 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.Nonempty;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.CollectionHelper;
import com.helger.commons.collection.ext.CommonsArrayList;
import com.helger.commons.collection.ext.CommonsLinkedHashMap;
import com.helger.commons.collection.ext.ICommonsList;
import com.helger.commons.collection.ext.ICommonsOrderedMap;
import com.helger.commons.string.StringHelper;
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 span-element.
* A portion of some paragraph that should be rendered in a distinct way, keyed * with the class attribute.
* An implementation is not required to make use of this element. * * @author Philip Helger */ @NotThreadSafe public class PSSpan implements IPSClonableElement , IPSOptionalElement, IPSHasForeignElements, IPSHasTexts { private String m_sClass; private final ICommonsList m_aContent = new CommonsArrayList <> (); private ICommonsOrderedMap m_aForeignAttrs; private ICommonsList m_aForeignElements; public PSSpan () {} public boolean isValid (@Nonnull final IPSErrorHandler aErrorHandler) { if (StringHelper.hasNoText (m_sClass)) { aErrorHandler.error (this, " has no 'class'"); return false; } if (m_aContent.isEmpty ()) { aErrorHandler.error (this, " has no content"); return false; } return true; } public void validateCompletely (@Nonnull final IPSErrorHandler aErrorHandler) { if (StringHelper.hasNoText (m_sClass)) aErrorHandler.error (this, " has no 'class'"); if (m_aContent.isEmpty ()) aErrorHandler.error (this, " has no content"); } public boolean isMinimal () { return true; } public void addForeignElement (@Nonnull final IMicroElement aForeignElement) { ValueEnforcer.notNull (aForeignElement, "ForeignElement"); if (aForeignElement.hasParent ()) throw new IllegalArgumentException ("ForeignElement already has a parent!"); if (m_aForeignElements == null) m_aForeignElements = new CommonsArrayList <> (); m_aForeignElements.add (aForeignElement); } public boolean hasForeignElements () { return m_aForeignElements != null && m_aForeignElements.isNotEmpty (); } @Nonnull @ReturnsMutableCopy public ICommonsList getAllForeignElements () { return new CommonsArrayList <> (m_aForeignElements); } 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); } public void setClazz (@Nullable final String sClass) { m_sClass = sClass; } @Nullable public String getClazz () { return m_sClass; } public void addText (@Nonnull @Nonempty final String sText) { ValueEnforcer.notEmpty (sText, "Text"); m_aContent.add (sText); } public boolean hasAnyText () { return m_aContent.isNotEmpty (); } @Nonnull @ReturnsMutableCopy public ICommonsList getAllTexts () { return m_aContent.getClone (); } @Nullable public String getAsText () { return StringHelper.getImploded (m_aContent); } @Nonnull public IMicroElement getAsMicroElement () { final IMicroElement ret = new MicroElement (CSchematron.NAMESPACE_SCHEMATRON, CSchematronXML.ELEMENT_SPAN); ret.setAttribute (CSchematronXML.ATTR_CLASS, m_sClass); if (m_aForeignElements != null) for (final IMicroElement aForeignElement : m_aForeignElements) ret.appendChild (aForeignElement.getClone ()); for (final String sContent : m_aContent) ret.appendText (sContent); if (m_aForeignAttrs != null) for (final Map.Entry aEntry : m_aForeignAttrs.entrySet ()) ret.setAttribute (aEntry.getKey (), aEntry.getValue ()); return ret; } @Nonnull public PSSpan getClone () { final PSSpan ret = new PSSpan (); ret.setClazz (m_sClass); for (final String sContent : m_aContent) ret.addText (sContent); if (hasForeignElements ()) ret.addForeignElements (m_aForeignElements); if (hasForeignAttributes ()) ret.addForeignAttributes (m_aForeignAttrs); return ret; } @Override public String toString () { return new ToStringGenerator (this).appendIfNotNull ("class", m_sClass) .appendIf ("content", m_aContent, CollectionHelper::isNotEmpty) .appendIf ("foreignAttrs", m_aForeignAttrs, CollectionHelper::isNotEmpty) .appendIf ("foreignElements", m_aForeignElements, CollectionHelper::isNotEmpty) .getToString (); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy