org.eclipse.osee.ote.core/src/org/eclipse/osee/ote/core/log/record/AttentionRecord.java

/*******************************************************************************
 * Copyright (c) 2004, 2007 Boeing.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Boeing - initial API and implementation
 *******************************************************************************/
package org.eclipse.osee.ote.core.log.record;

import java.util.logging.Level;

import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;

import org.codehaus.jackson.annotate.JsonProperty;
import org.eclipse.osee.framework.jdk.core.util.xml.Jaxp;
import org.eclipse.osee.ote.core.environment.interfaces.ITestEnvironmentAccessor;
import org.eclipse.osee.ote.core.log.TestLevel;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

/**
 * @author Charles Shaw
 */
public class AttentionRecord extends TestRecord {

   private static final long serialVersionUID = -6974833259038544176L;

   /**
    * AttentionRecord Constructor. Sets up generic message log message.
    * 
    * @param source The object requesting the logging.
    * @param msg The log message.
    * @param timeStamp <b>True</b> if a timestamp should be recorded, <b>False</b> if not.
    */
   public AttentionRecord(ITestEnvironmentAccessor source, String msg, boolean timeStamp) {
      super(source, TestLevel.ATTENTION, msg, timeStamp);
   }

   /**
    * MessagingRecord Constructor. Sets up generic message log message.
    * 
    * @param source The object requesting the logging.
    * @param msg The log message.
    */
   public AttentionRecord(ITestEnvironmentAccessor source, String msg) {
      this(source, msg, true);
   }

   /**
    * Converts log element to XML format.
    * 
    * @return xml formated element.
    */
   @Override
   public Element toXml(Document doc) {
      Element recordElement = doc.createElement(getLevel().getName());
      recordElement.appendChild(Jaxp.createElement(doc, "Message", getMessage()));
      //      for (Xmlizable object : getAdditionalXml()) {
      //         recordElement.appendChild(object.toXml(doc));
      //      }
      if (TestRecord.getLocationLoggingOn()) {
         recordElement.appendChild(getLocation(doc));
      }
      return recordElement;
   }

   @Override
   public void toXml(XMLStreamWriter writer) throws XMLStreamException {
      writer.writeStartElement(getLevel().getName());
      writeLocationCheckLocationLoggingOn(writer);
      writeMessage(writer);
      writer.writeEndElement();
   }
   
   @JsonProperty
   @Override
   public Level getLevel() {
	   return super.getLevel();
   }
}