/**
* The contents of this file are subject to the license and copyright
* detailed in the LICENSE and NOTICE files at the root of the source
* tree and available online at
*
* http://www.dspace.org/license/
*/
package org.purl.sword.atom;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import nu.xom.Attribute;
import nu.xom.Element;
import org.purl.sword.base.Namespaces;
import org.purl.sword.base.SwordElementInterface;
import org.purl.sword.base.UnmarshallException;
import org.purl.sword.base.XmlElement;
import org.apache.log4j.Logger;
import org.purl.sword.base.SwordValidationInfo;
import org.purl.sword.base.SwordValidationInfoType;
import org.purl.sword.base.XmlName;
/**
* Represents an ATOM Generator element.
*
* @author Neil Taylor
*/
public class Generator extends XmlElement implements SwordElementInterface
{
/**
* Label for the URI attribute.
*/
public static final String ATTRIBUTE_URI = "uri";
/**
* Label for the version attribute.
*/
public static final String ATTRIBUTE_VERSION = "version";
/**
* Local name for the element.
*/
@Deprecated
public static final String ELEMENT_NAME = "generator";
/**
* The content for the element.
*/
private String content;
/**
* The URI attribute.
*/
private String uri;
/**
* The version attribute.
*/
private String version;
/**
* The logger.
*/
private static Logger log = Logger.getLogger(Generator.class);
/**
* The Xml name details for the element.
*/
private static final XmlName XML_NAME = new XmlName(
Namespaces.PREFIX_ATOM, "generator", Namespaces.NS_ATOM);
/**
* Create a new instance and set the prefix to
* 'atom' and the local name to 'generator'.
*/
public Generator()
{
super(XML_NAME);
initialise();
}
public static XmlName elementName()
{
return XML_NAME;
}
protected final void initialise()
{
content = null;
version = null;
uri = null;
}
/**
* Marshal the data in the object to an Element object.
*
* @return The element.
*/
public Element marshall()
{
Element element = new Element(getQualifiedName(), xmlName.getNamespace());
if ( content != null )
{
element.appendChild(content);
}
if ( uri != null )
{
Attribute uriAttribute = new Attribute(ATTRIBUTE_URI, uri);
element.addAttribute(uriAttribute);
}
if ( version != null )
{
Attribute versionAttribute = new Attribute(ATTRIBUTE_VERSION, version);
element.addAttribute(versionAttribute);
}
return element;
}
/**
* Unmarshal the specified Generator element into the data in this object.
*
* @param generator The generator element.
*
* @throws UnmarshallException If the specified element is not an atom:generator
* element, or if there is an error accessing the data.
*/
public void unmarshall(Element generator)
throws UnmarshallException
{
unmarshall(generator, null);
}
public SwordValidationInfo unmarshall(Element generator, Properties validationProperties)
throws UnmarshallException
{
if ( ! isInstanceOf(generator, xmlName))
{
return handleIncorrectElement(generator, validationProperties);
}
ArrayList<SwordValidationInfo> validationItems = new ArrayList<SwordValidationInfo>();
ArrayList<SwordValidationInfo> attributeValidationItems = new ArrayList<SwordValidationInfo>();
try
{
initialise();
// get the attributes
int attributeCount = generator.getAttributeCount();
Attribute attribute = null;
for ( int i = 0; i < attributeCount; i++ )
{
attribute = generator.getAttribute(i);
if ( ATTRIBUTE_URI.equals(attribute.getQualifiedName()))
{
uri = attribute.getValue();
XmlName uriName = new XmlName(Namespaces.PREFIX_ATOM, ATTRIBUTE_URI, Namespaces.NS_ATOM);
SwordValidationInfo info = new SwordValidationInfo(xmlName, uriName);
info.setContentDescription(uri);
attributeValidationItems.add(info);
}
else if ( ATTRIBUTE_VERSION.equals(attribute.getQualifiedName()))
{
version = attribute.getValue();
XmlName versionName = new XmlName(Namespaces.PREFIX_ATOM, ATTRIBUTE_VERSION, Namespaces.NS_ATOM);
SwordValidationInfo info = new SwordValidationInfo(xmlName, versionName);
info.setContentDescription(version);
attributeValidationItems.add(info);
}
else
{
XmlName attributeName = new XmlName(attribute.getNamespacePrefix(),
attribute.getLocalName(),
attribute.getNamespaceURI());
SwordValidationInfo info = new SwordValidationInfo(xmlName, attributeName,
SwordValidationInfo.UNKNOWN_ATTRIBUTE,
SwordValidationInfoType.INFO);
info.setContentDescription(attribute.getValue());
validationItems.add(info);
}
}
int length = generator.getChildCount();
if ( length > 0 )
{
content = unmarshallString(generator);
}
}
catch ( Exception ex )
{
log.error("Unable to parse an element in Generator: " + ex.getMessage());
throw new UnmarshallException("Unable to parse element in Generator", ex);
}
SwordValidationInfo result = null;
if ( validationProperties != null )
{
result = validate(validationItems, attributeValidationItems, validationProperties);
}
return result;
}
/**
*
* @param validationContext FIXME: PLEASE DOCUMENT.
* @return SWORD validation info.
*/
@Override
public SwordValidationInfo validate(Properties validationContext)
{
return validate(null, null, validationContext);
}
/**
*
* @param existing add results to this.
* @param attributeItems add these too.
* @param validationContext FIXME: PLEASE DOCUMENT.
* @return SWORD validation info
*/
public SwordValidationInfo validate(List<SwordValidationInfo> existing,
List<SwordValidationInfo> attributeItems,
Properties validationContext)
{
boolean validateAll = (existing == null);
SwordValidationInfo result = new SwordValidationInfo(xmlName);
result.setContentDescription(content);
XmlName attributeName;
if ( content == null )
{
result.addValidationInfo(
new SwordValidationInfo(xmlName,
SwordValidationInfo.MISSING_CONTENT,
SwordValidationInfoType.WARNING));
}
if ( uri == null )
{
attributeName = new XmlName(Namespaces.PREFIX_ATOM,
ATTRIBUTE_URI,
Namespaces.NS_ATOM);
result.addAttributeValidationInfo(
new SwordValidationInfo(xmlName, attributeName,
SwordValidationInfo.MISSING_ATTRIBUTE_WARNING,
SwordValidationInfoType.WARNING));
}
else if ( validateAll && uri != null )
{
result.addAttributeValidationInfo(createValidAttributeInfo(ATTRIBUTE_URI, uri));
}
if ( version == null )
{
attributeName = new XmlName(Namespaces.PREFIX_ATOM,
ATTRIBUTE_VERSION,
Namespaces.NS_ATOM);
result.addAttributeValidationInfo(
new SwordValidationInfo(xmlName, attributeName,
SwordValidationInfo.MISSING_ATTRIBUTE_WARNING,
SwordValidationInfoType.WARNING));
}
else if ( validateAll && version != null )
{
result.addAttributeValidationInfo(createValidAttributeInfo(ATTRIBUTE_VERSION, version));
}
result.addUnmarshallValidationInfo(existing, attributeItems);
return result;
}
/**
* Get the content.
*
* @return The content.
*/
public String getContent() {
return content;
}
/**
* Set the content.
*
* @param content The content.
*/
public void setContent(String content) {
this.content = content;
}
/**
* Get the URI.
*
* @return The URI.
*/
public String getUri() {
return uri;
}
/**
* Set the URI.
*
* @param uri The URI.
*/
public void setUri(String uri) {
this.uri = uri;
}
/**
* Get the version.
*
* @return The version.
*/
public String getVersion() {
return version;
}
/**
* Set the version.
*
* @param version The version.
*/
public void setVersion(String version) {
this.version = version;
}
/**
* Get a string representation.
*/
public String toString()
{
return "Generator - content: " + getContent() +
" version: " + getVersion() +
" uri: " + getUri();
}
}