com.phloc.schematron.pure.model.IPSElement 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

Library for validating XML documents with Schematron

There is a newer version: 2.7.1

/**
 * 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.io.Serializable;

import javax.annotation.Nonnull;

import com.phloc.commons.log.InMemoryLogger;
import com.phloc.commons.microdom.IMicroElement;

/**
 * Base interface for a single Pure Schematron element
 * 
 * @author Philip Helger
 */
public interface IPSElement extends Serializable
{
  /**
   * @param aLogger
   *        The logger where the error details are stored. May not be
   *        null.
   * @return true if all mandatory fields are set and the element
   *         is valid, false otherwise.
   */
  boolean isValid (@Nonnull InMemoryLogger aLogger);

  /**
   * @return true if this element conforms to the Schematron
   *         minimal syntax, false otherwise.
   */
  boolean isMinimal ();

  /**
   * @return The XML representation of this element. Never null.
   */
  @Nonnull
  IMicroElement getAsMicroElement ();
}