xml.metadatasharing.Relationship Maven / Gradle / Ivy
Show all versions of stix Show documentation
/**
* Copyright (c) 2015, The MITRE Corporation. All rights reserved.
* See LICENSE for complete terms.
*/
//
// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.2.5-2
// See http://java.sun.com/xml/jaxb
// Any modifications to this file will be lost upon recompilation of the source schema.
// Generated on: 2015.07.01 at 03:19:53 PM EDT
//
package xml.metadatasharing;
import java.io.StringReader;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBElement;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Unmarshaller;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlSchemaType;
import javax.xml.bind.annotation.XmlType;
import javax.xml.datatype.XMLGregorianCalendar;
import javax.xml.namespace.QName;
import javax.xml.transform.stream.StreamSource;
import org.jvnet.jaxb2_commons.lang.Equals;
import org.jvnet.jaxb2_commons.lang.EqualsStrategy;
import org.jvnet.jaxb2_commons.lang.HashCode;
import org.jvnet.jaxb2_commons.lang.HashCodeStrategy;
import org.jvnet.jaxb2_commons.lang.JAXBEqualsStrategy;
import org.jvnet.jaxb2_commons.lang.JAXBHashCodeStrategy;
import org.jvnet.jaxb2_commons.lang.JAXBToStringStrategy;
import org.jvnet.jaxb2_commons.lang.ToString;
import org.jvnet.jaxb2_commons.lang.ToStringStrategy;
import org.jvnet.jaxb2_commons.locator.ObjectLocator;
import org.jvnet.jaxb2_commons.locator.util.LocatorUtils;
import org.mitre.stix.DocumentUtilities;
import org.mitre.stix.STIXSchema;
import org.mitre.stix.ValidationEventHandler;
import org.xml.sax.SAXException;
/**
*
* Relationships are used to express relationships between objects, and dates. Relationships have
* a type (an attribute with a defined list of allowed relationships), source (a set of xpath references to the parent end of
* the relationship), target (xpath references to the other end of the relationship) and an optional date.
*
* The linking of objects with types is a powerful way of describing data. The dates can be used to provide context.
*
* For example, to assign a classification to an object, that can done with an "isClassifiedAs" relationship, with the date meaning
* that that was the data that that classification was assigned.
*
* To show urls and the last visited data, this can be expressed as a "verifiedBy" relationship between the urls and the entity doing the
* verification, with the date interpreted as the verification date.
*
*
*
* Java class for relationship complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="relationship">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="source">
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="ref" type="{http://xml/metadataSharing.xsd}reference" maxOccurs="unbounded"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
* </element>
* <element name="target">
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="ref" type="{http://xml/metadataSharing.xsd}reference" maxOccurs="unbounded"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
* </element>
* <element name="timestamp" type="{http://www.w3.org/2001/XMLSchema}dateTime"/>
* </sequence>
* <attribute name="type" use="required" type="{http://xml/metadataSharing.xsd}RelationshipTypeEnum" />
* <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" />
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "relationship", propOrder = { "source", "target", "timestamp" })
public class Relationship implements Equals, HashCode, ToString {
@XmlElement(required = true)
protected Relationship.Source source;
@XmlElement(required = true)
protected Relationship.Target target;
@XmlElement(required = true)
@XmlSchemaType(name = "dateTime")
protected XMLGregorianCalendar timestamp;
@XmlAttribute(name = "type", required = true)
protected RelationshipTypeEnum type;
@XmlAttribute(name = "id")
@XmlSchemaType(name = "anySimpleType")
protected String id;
/**
* Default no-arg constructor
*
*/
public Relationship() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public Relationship(final Relationship.Source source,
final Relationship.Target target,
final XMLGregorianCalendar timestamp,
final RelationshipTypeEnum type, final String id) {
this.source = source;
this.target = target;
this.timestamp = timestamp;
this.type = type;
this.id = id;
}
/**
* Gets the value of the source property.
*
* @return
* possible object is
* {@link Relationship.Source }
*
*/
public Relationship.Source getSource() {
return source;
}
/**
* Sets the value of the source property.
*
* @param value
* allowed object is
* {@link Relationship.Source }
*
*/
public void setSource(Relationship.Source value) {
this.source = value;
}
/**
* Gets the value of the target property.
*
* @return
* possible object is
* {@link Relationship.Target }
*
*/
public Relationship.Target getTarget() {
return target;
}
/**
* Sets the value of the target property.
*
* @param value
* allowed object is
* {@link Relationship.Target }
*
*/
public void setTarget(Relationship.Target value) {
this.target = value;
}
/**
* Gets the value of the timestamp property.
*
* @return
* possible object is
* {@link XMLGregorianCalendar }
*
*/
public XMLGregorianCalendar getTimestamp() {
return timestamp;
}
/**
* Sets the value of the timestamp property.
*
* @param value
* allowed object is
* {@link XMLGregorianCalendar }
*
*/
public void setTimestamp(XMLGregorianCalendar value) {
this.timestamp = value;
}
/**
* Gets the value of the type property.
*
* @return
* possible object is
* {@link RelationshipTypeEnum }
*
*/
public RelationshipTypeEnum getType() {
return type;
}
/**
* Sets the value of the type property.
*
* @param value
* allowed object is
* {@link RelationshipTypeEnum }
*
*/
public void setType(RelationshipTypeEnum value) {
this.type = value;
}
/**
* Gets the value of the id property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getId() {
return id;
}
/**
* Sets the value of the id property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setId(String value) {
this.id = value;
}
public boolean equals(ObjectLocator thisLocator, ObjectLocator thatLocator,
Object object, EqualsStrategy strategy) {
if (!(object instanceof Relationship)) {
return false;
}
if (this == object) {
return true;
}
final Relationship that = ((Relationship) object);
{
Relationship.Source lhsSource;
lhsSource = this.getSource();
Relationship.Source rhsSource;
rhsSource = that.getSource();
if (!strategy.equals(
LocatorUtils.property(thisLocator, "source", lhsSource),
LocatorUtils.property(thatLocator, "source", rhsSource),
lhsSource, rhsSource)) {
return false;
}
}
{
Relationship.Target lhsTarget;
lhsTarget = this.getTarget();
Relationship.Target rhsTarget;
rhsTarget = that.getTarget();
if (!strategy.equals(
LocatorUtils.property(thisLocator, "target", lhsTarget),
LocatorUtils.property(thatLocator, "target", rhsTarget),
lhsTarget, rhsTarget)) {
return false;
}
}
{
XMLGregorianCalendar lhsTimestamp;
lhsTimestamp = this.getTimestamp();
XMLGregorianCalendar rhsTimestamp;
rhsTimestamp = that.getTimestamp();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"timestamp", lhsTimestamp), LocatorUtils.property(
thatLocator, "timestamp", rhsTimestamp), lhsTimestamp,
rhsTimestamp)) {
return false;
}
}
{
RelationshipTypeEnum lhsType;
lhsType = this.getType();
RelationshipTypeEnum rhsType;
rhsType = that.getType();
if (!strategy.equals(
LocatorUtils.property(thisLocator, "type", lhsType),
LocatorUtils.property(thatLocator, "type", rhsType),
lhsType, rhsType)) {
return false;
}
}
{
String lhsId;
lhsId = this.getId();
String rhsId;
rhsId = that.getId();
if (!strategy.equals(
LocatorUtils.property(thisLocator, "id", lhsId),
LocatorUtils.property(thatLocator, "id", rhsId), lhsId,
rhsId)) {
return false;
}
}
return true;
}
public boolean equals(Object object) {
final EqualsStrategy strategy = JAXBEqualsStrategy.INSTANCE;
return equals(null, null, object, strategy);
}
public int hashCode(ObjectLocator locator, HashCodeStrategy strategy) {
int currentHashCode = 1;
{
Relationship.Source theSource;
theSource = this.getSource();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "source", theSource),
currentHashCode, theSource);
}
{
Relationship.Target theTarget;
theTarget = this.getTarget();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "target", theTarget),
currentHashCode, theTarget);
}
{
XMLGregorianCalendar theTimestamp;
theTimestamp = this.getTimestamp();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "timestamp", theTimestamp),
currentHashCode, theTimestamp);
}
{
RelationshipTypeEnum theType;
theType = this.getType();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "type", theType),
currentHashCode, theType);
}
{
String theId;
theId = this.getId();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "id", theId),
currentHashCode, theId);
}
return currentHashCode;
}
public int hashCode() {
final HashCodeStrategy strategy = JAXBHashCodeStrategy.INSTANCE;
return this.hashCode(null, strategy);
}
public Relationship withSource(Relationship.Source value) {
setSource(value);
return this;
}
public Relationship withTarget(Relationship.Target value) {
setTarget(value);
return this;
}
public Relationship withTimestamp(XMLGregorianCalendar value) {
setTimestamp(value);
return this;
}
public Relationship withType(RelationshipTypeEnum value) {
setType(value);
return this;
}
public Relationship withId(String value) {
setId(value);
return this;
}
public String toString() {
final ToStringStrategy strategy = JAXBToStringStrategy.INSTANCE;
final StringBuilder buffer = new StringBuilder();
append(null, buffer, strategy);
return buffer.toString();
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
ToStringStrategy strategy) {
strategy.appendStart(locator, this, buffer);
appendFields(locator, buffer, strategy);
strategy.appendEnd(locator, this, buffer);
return buffer;
}
public StringBuilder appendFields(ObjectLocator locator,
StringBuilder buffer, ToStringStrategy strategy) {
{
Relationship.Source theSource;
theSource = this.getSource();
strategy.appendField(locator, this, "source", buffer, theSource);
}
{
Relationship.Target theTarget;
theTarget = this.getTarget();
strategy.appendField(locator, this, "target", buffer, theTarget);
}
{
XMLGregorianCalendar theTimestamp;
theTimestamp = this.getTimestamp();
strategy.appendField(locator, this, "timestamp", buffer,
theTimestamp);
}
{
RelationshipTypeEnum theType;
theType = this.getType();
strategy.appendField(locator, this, "type", buffer, theType);
}
{
String theId;
theId = this.getId();
strategy.appendField(locator, this, "id", buffer, theId);
}
return buffer;
}
/**
* Java class for anonymous complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="ref" type="{http://xml/metadataSharing.xsd}reference" maxOccurs="unbounded"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = { "reves" })
public static class Source implements Equals, HashCode, ToString {
@XmlElement(name = "ref", required = true)
protected List reves;
/**
* Default no-arg constructor
*
*/
public Source() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public Source(final List reves) {
this.reves = reves;
}
/**
* Gets the value of the reves property.
*
*
* This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
* This is why there is not a set method for the reves property.
*
*
* For example, to add a new item, do as follows:
*
* getReves().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link Reference }
*
*
*/
public List getReves() {
if (reves == null) {
reves = new ArrayList();
}
return this.reves;
}
public boolean equals(ObjectLocator thisLocator,
ObjectLocator thatLocator, Object object,
EqualsStrategy strategy) {
if (!(object instanceof Relationship.Source)) {
return false;
}
if (this == object) {
return true;
}
final Relationship.Source that = ((Relationship.Source) object);
{
List lhsReves;
lhsReves = (((this.reves != null) && (!this.reves.isEmpty())) ? this
.getReves() : null);
List rhsReves;
rhsReves = (((that.reves != null) && (!that.reves.isEmpty())) ? that
.getReves() : null);
if (!strategy.equals(
LocatorUtils.property(thisLocator, "reves", lhsReves),
LocatorUtils.property(thatLocator, "reves", rhsReves),
lhsReves, rhsReves)) {
return false;
}
}
return true;
}
public boolean equals(Object object) {
final EqualsStrategy strategy = JAXBEqualsStrategy.INSTANCE;
return equals(null, null, object, strategy);
}
public int hashCode(ObjectLocator locator, HashCodeStrategy strategy) {
int currentHashCode = 1;
{
List theReves;
theReves = (((this.reves != null) && (!this.reves.isEmpty())) ? this
.getReves() : null);
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "reves", theReves),
currentHashCode, theReves);
}
return currentHashCode;
}
public int hashCode() {
final HashCodeStrategy strategy = JAXBHashCodeStrategy.INSTANCE;
return this.hashCode(null, strategy);
}
public Relationship.Source withReves(Reference... values) {
if (values != null) {
for (Reference value : values) {
getReves().add(value);
}
}
return this;
}
public Relationship.Source withReves(Collection values) {
if (values != null) {
getReves().addAll(values);
}
return this;
}
public String toString() {
final ToStringStrategy strategy = JAXBToStringStrategy.INSTANCE;
final StringBuilder buffer = new StringBuilder();
append(null, buffer, strategy);
return buffer.toString();
}
public StringBuilder append(ObjectLocator locator,
StringBuilder buffer, ToStringStrategy strategy) {
strategy.appendStart(locator, this, buffer);
appendFields(locator, buffer, strategy);
strategy.appendEnd(locator, this, buffer);
return buffer;
}
public StringBuilder appendFields(ObjectLocator locator,
StringBuilder buffer, ToStringStrategy strategy) {
{
List theReves;
theReves = (((this.reves != null) && (!this.reves.isEmpty())) ? this
.getReves() : null);
strategy.appendField(locator, this, "reves", buffer, theReves);
}
return buffer;
}
}
/**
* Java class for anonymous complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="ref" type="{http://xml/metadataSharing.xsd}reference" maxOccurs="unbounded"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = { "reves" })
public static class Target implements Equals, HashCode, ToString {
@XmlElement(name = "ref", required = true)
protected List reves;
/**
* Default no-arg constructor
*
*/
public Target() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public Target(final List reves) {
this.reves = reves;
}
/**
* Gets the value of the reves property.
*
*
* This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
* This is why there is not a set method for the reves property.
*
*
* For example, to add a new item, do as follows:
*
* getReves().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link Reference }
*
*
*/
public List getReves() {
if (reves == null) {
reves = new ArrayList();
}
return this.reves;
}
public boolean equals(ObjectLocator thisLocator,
ObjectLocator thatLocator, Object object,
EqualsStrategy strategy) {
if (!(object instanceof Relationship.Target)) {
return false;
}
if (this == object) {
return true;
}
final Relationship.Target that = ((Relationship.Target) object);
{
List lhsReves;
lhsReves = (((this.reves != null) && (!this.reves.isEmpty())) ? this
.getReves() : null);
List rhsReves;
rhsReves = (((that.reves != null) && (!that.reves.isEmpty())) ? that
.getReves() : null);
if (!strategy.equals(
LocatorUtils.property(thisLocator, "reves", lhsReves),
LocatorUtils.property(thatLocator, "reves", rhsReves),
lhsReves, rhsReves)) {
return false;
}
}
return true;
}
public boolean equals(Object object) {
final EqualsStrategy strategy = JAXBEqualsStrategy.INSTANCE;
return equals(null, null, object, strategy);
}
public int hashCode(ObjectLocator locator, HashCodeStrategy strategy) {
int currentHashCode = 1;
{
List theReves;
theReves = (((this.reves != null) && (!this.reves.isEmpty())) ? this
.getReves() : null);
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "reves", theReves),
currentHashCode, theReves);
}
return currentHashCode;
}
public int hashCode() {
final HashCodeStrategy strategy = JAXBHashCodeStrategy.INSTANCE;
return this.hashCode(null, strategy);
}
public Relationship.Target withReves(Reference... values) {
if (values != null) {
for (Reference value : values) {
getReves().add(value);
}
}
return this;
}
public Relationship.Target withReves(Collection values) {
if (values != null) {
getReves().addAll(values);
}
return this;
}
public String toString() {
final ToStringStrategy strategy = JAXBToStringStrategy.INSTANCE;
final StringBuilder buffer = new StringBuilder();
append(null, buffer, strategy);
return buffer.toString();
}
public StringBuilder append(ObjectLocator locator,
StringBuilder buffer, ToStringStrategy strategy) {
strategy.appendStart(locator, this, buffer);
appendFields(locator, buffer, strategy);
strategy.appendEnd(locator, this, buffer);
return buffer;
}
public StringBuilder appendFields(ObjectLocator locator,
StringBuilder buffer, ToStringStrategy strategy) {
{
List theReves;
theReves = (((this.reves != null) && (!this.reves.isEmpty())) ? this
.getReves() : null);
strategy.appendField(locator, this, "reves", buffer, theReves);
}
return buffer;
}
}
/**
* Returns A Document representation of this instance that is not formatted.
*
* @return The Document representation for this instance.
*/
public org.w3c.dom.Document toDocument() {
return toDocument(false);
}
/**
* Returns A Document representation for this instance.
*
* @param prettyPrint
* True for pretty print, otherwise false
*
* @return The Document representation for this instance.
*/
public org.w3c.dom.Document toDocument(boolean prettyPrint) {
return DocumentUtilities.toDocument(toJAXBElement(), prettyPrint);
}
/**
* Returns JAXBElement for this instance.
*
* @return The JAXBElement for this instance.
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
public JAXBElement toJAXBElement() {
QName qualifiedName = STIXSchema.getQualifiedName(this);
return new JAXBElement(qualifiedName, Relationship.class, this);
}
/**
* Returns String representation of this instance that is not formatted.
*
* @return The String containing the XML mark-up.
*/
public String toXMLString() {
return toXMLString(false);
}
/**
* Returns XML String for JAXB Document Object Model object.
*
* @param prettyPrint
* True for pretty print, otherwise false
*
* @return The String containing the XML mark-up.
*/
public String toXMLString(boolean prettyPrint) {
return DocumentUtilities.toXMLString(toDocument(), prettyPrint);
}
/**
* Creates Relationship instance for XML String
*
* @param text
* XML String for the document
* @return The Relationship instance for the passed XML String
*/
public static Relationship fromXMLString(String text) {
JAXBContext jaxbContext;
try {
jaxbContext = JAXBContext.newInstance(Relationship.class
.getPackage().getName());
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
unmarshaller.setSchema(STIXSchema.getInstance().getSchema());
unmarshaller.setEventHandler(new ValidationEventHandler());
StreamSource streamSource = new StreamSource(new StringReader(text));
return (Relationship) unmarshaller.unmarshal(streamSource);
} catch (JAXBException e) {
throw new RuntimeException(e);
}
}
/**
* Validates the XML representation of this Relationship instance
* Returning true indicating a successful validation, false if not.
*
* @return boolean True If it validates against the schema
* @throws SAXException
* If the a validation ErrorHandler has not been set, and
* validation throws a SAXException
*/
public boolean validate() throws SAXException {
return STIXSchema.getInstance().validate(toXMLString());
}
}