/**
* Copyright 2005-2014 Restlet
*
* The contents of this file are subject to the terms of one of the following
* open source licenses: Apache 2.0 or or EPL 1.0 (the "Licenses"). You can
* select the license that you prefer but you may not use this file except in
* compliance with one of these Licenses.
*
* You can obtain a copy of the Apache 2.0 license at
* http://www.opensource.org/licenses/apache-2.0
*
* You can obtain a copy of the EPL 1.0 license at
* http://www.opensource.org/licenses/eclipse-1.0
*
* See the Licenses for the specific language governing permissions and
* limitations under the Licenses.
*
* Alternatively, you can obtain a royalty free commercial license with less
* limitations, transferable or non-transferable, directly at
* http://restlet.com/products/restlet-framework
*
* Restlet is a registered trademark of Restlet S.A.S.
*/
package org.restlet.ext.wadl;
import static org.restlet.ext.wadl.WadlRepresentation.APP_NAMESPACE;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.restlet.data.MediaType;
import org.restlet.data.Reference;
import org.restlet.ext.xml.XmlWriter;
import org.restlet.representation.Variant;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.AttributesImpl;
/**
* Describes a variant representation for a target resource.
*
* @author Jerome Louvel
*/
public class RepresentationInfo extends DocumentedInfo {
/** Identifier for that element. */
private String identifier;
/** Media type of that element. */
private MediaType mediaType;
/** List of parameters. */
private List<ParameterInfo> parameters;
/** List of locations of one or more meta data profiles. */
private List<Reference> profiles;
/** Reference to an representation identifier. */
private String reference;
/** Qualified name of the root element for this XML-based representation. */
private String xmlElement;
/**
* Constructor.
*/
public RepresentationInfo() {
super();
}
/**
* Constructor with a single documentation element.
*
* @param documentation
* A single documentation element.
*/
public RepresentationInfo(DocumentationInfo documentation) {
super(documentation);
}
/**
* Constructor with a list of documentation elements.
*
* @param documentations
* The list of documentation elements.
*/
public RepresentationInfo(List<DocumentationInfo> documentations) {
super(documentations);
}
/**
* Constructor with a media type.
*
* @param mediaType
* The media type of the representation.
*/
public RepresentationInfo(MediaType mediaType) {
setMediaType(mediaType);
}
/**
* Constructor with a single documentation element.
*
* @param documentation
* A single documentation element.
*/
public RepresentationInfo(String documentation) {
super(documentation);
}
/**
* Constructor with a variant.
*
* @param variant
* The variant to describe.
*/
public RepresentationInfo(Variant variant) {
setMediaType(variant.getMediaType());
}
/**
* Returns the identifier for that element.
*
* @return The identifier for that element.
*/
public String getIdentifier() {
return this.identifier;
}
/**
* Returns the media type of that element.
*
* @return The media type of that element.
*/
public MediaType getMediaType() {
return this.mediaType;
}
/**
* Returns the list of parameters.
*
* @return The list of parameters.
*/
public List<ParameterInfo> getParameters() {
// Lazy initialization with double-check.
List<ParameterInfo> p = this.parameters;
if (p == null) {
synchronized (this) {
p = this.parameters;
if (p == null) {
this.parameters = p = new ArrayList<ParameterInfo>();
}
}
}
return p;
}
/**
* Returns the list of locations of one or more meta data profiles.
*
* @return The list of locations of one or more meta data profiles.
*/
public List<Reference> getProfiles() {
// Lazy initialization with double-check.
List<Reference> p = this.profiles;
if (p == null) {
synchronized (this) {
p = this.profiles;
if (p == null) {
this.profiles = p = new ArrayList<Reference>();
}
}
}
return p;
}
/**
* Returns the reference to an representation identifier.
*
* @return The reference to an representation identifier.
*/
public String getReference() {
return reference;
}
/**
* Returns the qualified name of the root element for this XML-based
* representation.
*
* @return The qualified name of the root element for this XML-based
* representation.
*/
public String getXmlElement() {
return this.xmlElement;
}
/**
* Sets the identifier for that element.
*
* @param identifier
* The identifier for that element.
*/
public void setIdentifier(String identifier) {
this.identifier = identifier;
}
/**
* Sets the media type of that element.
*
* @param mediaType
* The media type of that element.
*/
public void setMediaType(MediaType mediaType) {
this.mediaType = mediaType;
}
/**
* Sets the list of parameters.
*
* @param parameters
* The list of parameters.
*/
public void setParameters(List<ParameterInfo> parameters) {
this.parameters = parameters;
}
/**
* Sets the list of locations of one or more meta data profiles.
*
* @param profiles
* The list of locations of one or more meta data profiles.
*/
public void setProfiles(List<Reference> profiles) {
this.profiles = profiles;
}
/**
* Sets the reference to an representation identifier.
*
* @param reference
* The reference to an representation identifier.
*/
public void setReference(String reference) {
this.reference = reference;
}
/**
* Sets the qualified name of the root element for this XML-based
* representation.
*
* @param xmlElement
* The qualified name of the root element for this XML-based
* representation.
*/
public void setXmlElement(String xmlElement) {
this.xmlElement = xmlElement;
}
@Override
public void updateNamespaces(Map<String, String> namespaces) {
namespaces.putAll(resolveNamespaces());
for (final ParameterInfo parameterInfo : getParameters()) {
parameterInfo.updateNamespaces(namespaces);
}
}
/**
* Writes the current object as an XML element using the given SAX writer.
*
* @param writer
* The SAX writer.
* @throws SAXException
*/
public void writeElement(XmlWriter writer) throws SAXException {
AttributesImpl attributes = new AttributesImpl();
if ((getReference() != null) && !getReference().equals("")) {
attributes.addAttribute("", "href", null, "xs:anyURI", "#"
+ getReference());
writer.emptyElement(APP_NAMESPACE, "representation", null,
attributes);
} else {
if ((getIdentifier() != null) && !getIdentifier().equals("")) {
attributes.addAttribute("", "id", null, "xs:ID",
getIdentifier());
}
if (getMediaType() != null) {
attributes.addAttribute("", "mediaType", null, "xs:string",
getMediaType().toString());
}
if ((getProfiles() != null) && !getProfiles().isEmpty()) {
StringBuilder builder = new StringBuilder();
for (Iterator<Reference> iterator = getProfiles().iterator(); iterator
.hasNext();) {
Reference reference = iterator.next();
builder.append(reference.toString());
if (iterator.hasNext()) {
builder.append(" ");
}
}
attributes.addAttribute("", "profile", null, "xs:string",
builder.toString());
}
if ((getXmlElement() != null) && !getXmlElement().equals("")) {
attributes.addAttribute("", "element", null, "xs:QName",
getXmlElement());
}
if (getDocumentations().isEmpty() && getParameters().isEmpty()) {
writer.emptyElement(APP_NAMESPACE, "representation", null,
attributes);
} else {
writer.startElement(APP_NAMESPACE, "representation", null,
attributes);
for (DocumentationInfo documentationInfo : getDocumentations()) {
documentationInfo.writeElement(writer);
}
for (ParameterInfo parameterInfo : getParameters()) {
parameterInfo.writeElement(writer);
}
writer.endElement(APP_NAMESPACE, "representation");
}
}
}
}