com.phloc.schematron.pure.model.PSPattern Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of phloc-schematron Show documentation
Show all versions of phloc-schematron Show documentation
Library for validating XML documents with Schematron
/**
* Copyright (C) 2014 phloc systems
* http://www.phloc.com
* office[at]phloc[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.phloc.schematron.pure.model;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import com.phloc.commons.ValueEnforcer;
import com.phloc.commons.annotations.ReturnsMutableCopy;
import com.phloc.commons.collections.ContainerHelper;
import com.phloc.commons.log.InMemoryLogger;
import com.phloc.commons.microdom.IMicroElement;
import com.phloc.commons.microdom.impl.MicroElement;
import com.phloc.commons.string.StringHelper;
import com.phloc.commons.string.ToStringGenerator;
import com.phloc.schematron.CSchematron;
import com.phloc.schematron.CSchematronXML;
/**
* A single Schematron pattern-element.
* A structure, simple or complex. A set of rules giving constraints that are in
* some way related. The id attribute provides a unique name for the pattern and
* is required for abstract patterns.
* The title and p elements allow rich documentation.
* The icon, see and fpi attributes allow rich interfaces and documentation.
* When a pattern element has the attribute abstract with a value true, then the
* pattern defines an abstract pattern. An abstract pattern shall not have a
* is-a attribute and shall have an id attribute.
* Abstract patterns allow a common definition mechanism for structures which
* use different names and paths, but which are at heart the same. For example,
* there are different table markup languages, but they all can be in large part
* represented as an abstract pattern where a table contains rows and rows
* contain entries, as defined in the following example using the default query
* language binding:
*
*
*
*
*
* The element
*
*
*
* The element
*
*
*
*
* When a pattern element has the attribute is-a with a value specifying the
* name of an abstract pattern, then the pattern is an instance of an abstract
* pattern. Such a pattern shall not contain any rule elements, but shall have
* param elements for all parameters used in the abstract pattern.
* The following example uses the abstract pattern for tables given above to
* create three patterns for tables with different names or structures.
*
*
*
*
*
*
*
*
*
*
* When creating an instance of an abstract pattern, the parameter values
* supplied by the param element replace the parameter references used in the
* abstract patterns. The examples above use the default query language binding
* in which the character $ is used as the delimiter for parameter references.
* Thus, given the abstract patterns defined earlier in this clause, the
* patterns defined above are equivalent to the following, with the id elements
* shown expanded:
*
*
*
*
*
* The element table is a table. Tables containing rows.
*
*
*
*
* The element tr is a table row. Rows contain entries.
*
*
*
*
*
*
* The element table is a table. Tables containing rows.
*
*
*
*
* The element row is a table row. Rows contain entries.
*
*
*
*
*
*
* The element year is a table. Tables containing rows.
*
*
*
*
* The element week is a table row. Rows contain entries.
*
*
*
*
*
* @author Philip Helger
*/
@NotThreadSafe
public class PSPattern implements IPSElement, IPSHasID, IPSHasForeignElements, IPSHasIncludes, IPSHasLets, IPSHasRichGroup
{
private boolean m_bAbstract = false;
private String m_sID;
private String m_sIsA;
private PSRichGroup m_aRich;
private final List m_aIncludes = new ArrayList ();
private PSTitle m_aTitle;
private final List m_aContent = new ArrayList ();
private Map m_aForeignAttrs;
private List m_aForeignElements;
public PSPattern ()
{}
public boolean isValid (@Nonnull final InMemoryLogger aLogger)
{
// If abstract, an ID must be present
if (m_bAbstract && StringHelper.hasNoText (m_sID))
{
aLogger.error ("abstract does not have an 'id'");
return false;
}
// is-a may not be present for abstract rules
if (m_bAbstract && StringHelper.hasText (m_sIsA))
{
aLogger.error ("abstract may not have an 'is-a'");
return false;
}
if (StringHelper.hasNoText (m_sIsA))
{
// param only if is-a is set
for (final IPSElement aContent : m_aContent)
if (aContent instanceof PSParam)
{
aLogger.error (" without 'is-a' may not contain s");
return false;
}
}
else
{
// rule and let only if is-a is not set
for (final IPSElement aContent : m_aContent)
{
if (aContent instanceof PSRule)
{
aLogger.error (" with 'is-a' may not contain s");
return false;
}
if (aContent instanceof PSLet)
{
aLogger.error (" with 'is-a' may not contain s");
return false;
}
}
}
for (final PSInclude aInclude : m_aIncludes)
if (!aInclude.isValid (aLogger))
return false;
if (m_aTitle != null && !m_aTitle.isValid (aLogger))
return false;
for (final IPSElement aContent : m_aContent)
if (!aContent.isValid (aLogger))
return false;
return true;
}
public boolean isMinimal ()
{
if (m_bAbstract)
return false;
if (StringHelper.hasText (m_sIsA))
return false;
for (final PSInclude aInclude : m_aIncludes)
if (!aInclude.isMinimal ())
return false;
if (m_aTitle != null && !m_aTitle.isMinimal ())
return false;
for (final IPSElement aContent : m_aContent)
if (!aContent.isMinimal ())
return false;
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 ArrayList ();
m_aForeignElements.add (aForeignElement);
}
public void addForeignElements (@Nonnull final List aForeignElements)
{
ValueEnforcer.notNull (aForeignElements, "ForeignElements");
for (final IMicroElement aForeignElement : aForeignElements)
addForeignElement (aForeignElement);
}
public boolean hasForeignElements ()
{
return m_aForeignElements != null && !m_aForeignElements.isEmpty ();
}
@Nonnull
@ReturnsMutableCopy
public List getAllForeignElements ()
{
return ContainerHelper.newList (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 LinkedHashMap ();
m_aForeignAttrs.put (sAttrName, sAttrValue);
}
public void addForeignAttributes (@Nonnull final Map aForeignAttrs)
{
ValueEnforcer.notNull (aForeignAttrs, "ForeignAttrs");
for (final Map.Entry aEntry : aForeignAttrs.entrySet ())
addForeignAttribute (aEntry.getKey (), aEntry.getValue ());
}
public boolean hasForeignAttributes ()
{
return m_aForeignAttrs != null && !m_aForeignAttrs.isEmpty ();
}
@Nonnull
@ReturnsMutableCopy
public Map getAllForeignAttributes ()
{
return ContainerHelper.newOrderedMap (m_aForeignAttrs);
}
public void setAbstract (final boolean bAbstract)
{
m_bAbstract = bAbstract;
}
public boolean isAbstract ()
{
return m_bAbstract;
}
public void setID (@Nullable final String sID)
{
m_sID = sID;
}
public boolean hasID ()
{
return m_sID != null;
}
@Nullable
public String getID ()
{
return m_sID;
}
public void setIsA (@Nullable final String sIsA)
{
m_sIsA = sIsA;
}
@Nullable
public String getIsA ()
{
return m_sIsA;
}
public void setRich (@Nullable final PSRichGroup aRich)
{
m_aRich = aRich;
}
public boolean hasRich ()
{
return m_aRich != null;
}
@Nullable
public PSRichGroup getRich ()
{
return m_aRich;
}
@Nullable
public PSRichGroup getRichClone ()
{
return m_aRich == null ? null : m_aRich.getClone ();
}
public void addInclude (@Nonnull final PSInclude aInclude)
{
ValueEnforcer.notNull (aInclude, "Include");
m_aIncludes.add (aInclude);
}
public boolean hasAnyInclude ()
{
return !m_aIncludes.isEmpty ();
}
@Nonnull
@ReturnsMutableCopy
public List getAllIncludes ()
{
return ContainerHelper.newList (m_aIncludes);
}
public void setTitle (@Nullable final PSTitle aTitle)
{
m_aTitle = aTitle;
}
@Nullable
public PSTitle getTitle ()
{
return m_aTitle;
}
public boolean hasTitle ()
{
return m_aTitle != null;
}
public void addRule (@Nonnull final PSRule aRule)
{
ValueEnforcer.notNull (aRule, "Rule");
m_aContent.add (aRule);
}
@Nullable
public PSRule getRuleOfID (@Nullable final String sID)
{
if (StringHelper.hasText (sID))
for (final IPSElement aElement : m_aContent)
if (aElement instanceof PSRule)
{
final PSRule aRule = (PSRule) aElement;
if (sID.equals (aRule.getID ()))
return aRule;
}
return null;
}
@Nonnull
@ReturnsMutableCopy
public List getAllRules ()
{
final List ret = new ArrayList ();
for (final IPSElement aElement : m_aContent)
if (aElement instanceof PSRule)
ret.add ((PSRule) aElement);
return ret;
}
@Nonnegative
public int getRuleCount ()
{
int ret = 0;
for (final IPSElement aElement : m_aContent)
if (aElement instanceof PSRule)
ret++;
return ret;
}
public void addParam (@Nonnull final PSParam aParam)
{
ValueEnforcer.notNull (aParam, "Param");
m_aContent.add (aParam);
}
@Nonnull
@ReturnsMutableCopy
public List getAllParams ()
{
final List ret = new ArrayList ();
for (final IPSElement aElement : m_aContent)
if (aElement instanceof PSParam)
ret.add ((PSParam) aElement);
return ret;
}
public boolean hasAnyParam ()
{
for (final IPSElement aElement : m_aContent)
if (aElement instanceof PSParam)
return true;
return false;
}
public void addP (@Nonnull final PSP aP)
{
ValueEnforcer.notNull (aP, "P");
m_aContent.add (aP);
}
@Nonnull
@ReturnsMutableCopy
public List getAllPs ()
{
final List ret = new ArrayList ();
for (final IPSElement aElement : m_aContent)
if (aElement instanceof PSP)
ret.add ((PSP) aElement);
return ret;
}
public void addLet (@Nonnull final PSLet aLet)
{
ValueEnforcer.notNull (aLet, "Let");
m_aContent.add (aLet);
}
public boolean hasAnyLet ()
{
for (final IPSElement aElement : m_aContent)
if (aElement instanceof PSLet)
return true;
return false;
}
@Nonnull
@ReturnsMutableCopy
public List getAllLets ()
{
final List ret = new ArrayList ();
for (final IPSElement aElement : m_aContent)
if (aElement instanceof PSLet)
ret.add ((PSLet) aElement);
return ret;
}
@Nonnull
@ReturnsMutableCopy
public Map getAllLetsAsMap ()
{
final Map ret = new LinkedHashMap ();
for (final IPSElement aElement : m_aContent)
if (aElement instanceof PSLet)
{
final PSLet aLet = (PSLet) aElement;
ret.put (aLet.getName (), aLet.getValue ());
}
return ret;
}
/**
* @return A list consisting of {@link PSP}, {@link PSLet}, {@link PSRule} and
* {@link PSParam} parameters
*/
@Nonnull
@ReturnsMutableCopy
public List getAllContentElements ()
{
return ContainerHelper.newList (m_aContent);
}
@Nonnull
public IMicroElement getAsMicroElement ()
{
final IMicroElement ret = new MicroElement (CSchematron.NAMESPACE_SCHEMATRON, CSchematronXML.ELEMENT_PATTERN);
if (m_bAbstract)
ret.setAttribute (CSchematronXML.ATTR_ABSTRACT, "true");
ret.setAttribute (CSchematronXML.ATTR_ID, m_sID);
ret.setAttribute (CSchematronXML.ATTR_IS_A, m_sIsA);
if (m_aRich != null)
m_aRich.fillMicroElement (ret);
if (m_aForeignElements != null)
for (final IMicroElement aForeignElement : m_aForeignElements)
ret.appendChild (aForeignElement.getClone ());
for (final PSInclude aInclude : m_aIncludes)
ret.appendChild (aInclude.getAsMicroElement ());
if (m_aTitle != null)
ret.appendChild (m_aTitle.getAsMicroElement ());
for (final IPSElement aContent : m_aContent)
ret.appendChild (aContent.getAsMicroElement ());
if (m_aForeignAttrs != null)
for (final Map.Entry aEntry : m_aForeignAttrs.entrySet ())
ret.setAttribute (aEntry.getKey (), aEntry.getValue ());
return ret;
}
@Override
public String toString ()
{
return new ToStringGenerator (this).append ("abstract", m_bAbstract)
.appendIfNotNull ("id", m_sID)
.appendIfNotNull ("is-a", m_sIsA)
.appendIfNotNull ("rich", m_aRich)
.append ("includes", m_aIncludes)
.appendIfNotNull ("title", m_aTitle)
.append ("content", m_aContent)
.appendIfNotNull ("foreignAttrs", m_aForeignAttrs)
.appendIfNotNull ("foreignElements", m_aForeignElements)
.toString ();
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy