oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2.DimensionType Maven / Gradle / Ivy
package oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2;
import java.io.Serializable;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;
import com.phloc.commons.annotations.ReturnsMutableObject;
import com.phloc.commons.equals.EqualsUtils;
import com.phloc.commons.hash.HashCodeGenerator;
import com.phloc.commons.string.ToStringGenerator;
import oasis.names.specification.ubl.schema.xsd.commonbasiccomponents_2.AttributeIDType;
import oasis.names.specification.ubl.schema.xsd.commonbasiccomponents_2.DescriptionType;
import oasis.names.specification.ubl.schema.xsd.commonbasiccomponents_2.MaximumMeasureType;
import oasis.names.specification.ubl.schema.xsd.commonbasiccomponents_2.MeasureType;
import oasis.names.specification.ubl.schema.xsd.commonbasiccomponents_2.MinimumMeasureType;
/**
*
*
* <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ABIE</ccts:ComponentType><ccts:DictionaryEntryName>Dimension. Details</ccts:DictionaryEntryName><ccts:Definition>Information about a measurable dimension of an item.</ccts:Definition><ccts:ObjectClass>Dimension</ccts:ObjectClass></ccts:Component>
*
*
*
* Java class for DimensionType complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="DimensionType">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}AttributeID"/>
* <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Measure" minOccurs="0"/>
* <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Description" maxOccurs="unbounded" minOccurs="0"/>
* <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}MinimumMeasure" minOccurs="0"/>
* <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}MaximumMeasure" minOccurs="0"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "DimensionType", propOrder = {
"attributeID",
"measure",
"description",
"minimumMeasure",
"maximumMeasure"
})
public class DimensionType implements Serializable
{
@XmlElement(name = "AttributeID", namespace = "urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2", required = true)
private AttributeIDType attributeID;
@XmlElement(name = "Measure", namespace = "urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2")
private MeasureType measure;
@XmlElement(name = "Description", namespace = "urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2")
private List description;
@XmlElement(name = "MinimumMeasure", namespace = "urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2")
private MinimumMeasureType minimumMeasure;
@XmlElement(name = "MaximumMeasure", namespace = "urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2")
private MaximumMeasureType maximumMeasure;
/**
* Default constructor
* Created by phloc-ubl-jaxb-plugin -Xphloc-ubl-value
*
*/
public DimensionType() {
}
/**
*
*
* <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Dimension. Attribute Identifier. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for the attribute to which the measure applies.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Dimension</ccts:ObjectClass><ccts:PropertyTerm>Attribute Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType></ccts:Component>
*
*
*
* @return
* possible object is
* {@link AttributeIDType }
*
*/
@Nullable
public AttributeIDType getAttributeID() {
return attributeID;
}
/**
* Sets the value of the attributeID property.
*
* @param value
* allowed object is
* {@link AttributeIDType }
*
*/
public void setAttributeID(
@Nullable
AttributeIDType value) {
this.attributeID = value;
}
/**
*
*
* <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Dimension. Measure</ccts:DictionaryEntryName><ccts:Definition>The measurement value.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Dimension</ccts:ObjectClass><ccts:PropertyTerm>Measure</ccts:PropertyTerm><ccts:RepresentationTerm>Measure</ccts:RepresentationTerm><ccts:DataType>Measure. Type</ccts:DataType></ccts:Component>
*
*
*
* @return
* possible object is
* {@link MeasureType }
*
*/
@Nullable
public MeasureType getMeasure() {
return measure;
}
/**
* Sets the value of the measure property.
*
* @param value
* allowed object is
* {@link MeasureType }
*
*/
public void setMeasure(
@Nullable
MeasureType value) {
this.measure = value;
}
/**
*
*
* <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Dimension. Description. Text</ccts:DictionaryEntryName><ccts:Definition>A description of the attribute or measurement of the attribute.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Dimension</ccts:ObjectClass><ccts:PropertyTerm>Description</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
*
* Gets the value of the description 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 description property.
*
*
* For example, to add a new item, do as follows:
*
* getDescription().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link DescriptionType }
*
*
*/
@Nonnull
@ReturnsMutableObject(reason = "JAXB implementation style")
public List getDescription() {
if (description == null) {
description = new ArrayList();
}
return this.description;
}
/**
*
*
* <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Dimension. Minimum_ Measure. Measure</ccts:DictionaryEntryName><ccts:Definition>The minimum value in a range of measurement.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Dimension</ccts:ObjectClass><ccts:PropertyTermQualifier>Minimum</ccts:PropertyTermQualifier><ccts:PropertyTerm>Measure</ccts:PropertyTerm><ccts:RepresentationTerm>Measure</ccts:RepresentationTerm><ccts:DataType>Measure. Type</ccts:DataType></ccts:Component>
*
*
*
* @return
* possible object is
* {@link MinimumMeasureType }
*
*/
@Nullable
public MinimumMeasureType getMinimumMeasure() {
return minimumMeasure;
}
/**
* Sets the value of the minimumMeasure property.
*
* @param value
* allowed object is
* {@link MinimumMeasureType }
*
*/
public void setMinimumMeasure(
@Nullable
MinimumMeasureType value) {
this.minimumMeasure = value;
}
/**
*
*
* <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Dimension. Maximum_ Measure. Measure</ccts:DictionaryEntryName><ccts:Definition>The maximum value in a range of measurement.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Dimension</ccts:ObjectClass><ccts:PropertyTermQualifier>Maximum</ccts:PropertyTermQualifier><ccts:PropertyTerm>Measure</ccts:PropertyTerm><ccts:RepresentationTerm>Measure</ccts:RepresentationTerm><ccts:DataType>Measure. Type</ccts:DataType></ccts:Component>
*
*
*
* @return
* possible object is
* {@link MaximumMeasureType }
*
*/
@Nullable
public MaximumMeasureType getMaximumMeasure() {
return maximumMeasure;
}
/**
* Sets the value of the maximumMeasure property.
*
* @param value
* allowed object is
* {@link MaximumMeasureType }
*
*/
public void setMaximumMeasure(
@Nullable
MaximumMeasureType value) {
this.maximumMeasure = value;
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-equalshashcode
*
*/
@Override
public boolean equals(final Object o) {
if (o == this) {
return true;
}
if ((o == null)||(!getClass().equals(o.getClass()))) {
return false;
}
final DimensionType rhs = ((DimensionType) o);
if (!EqualsUtils.equals(attributeID, rhs.attributeID)) {
return false;
}
if (!EqualsUtils.equals(measure, rhs.measure)) {
return false;
}
if (!EqualsUtils.equals(description, rhs.description)) {
return false;
}
if (!EqualsUtils.equals(minimumMeasure, rhs.minimumMeasure)) {
return false;
}
if (!EqualsUtils.equals(maximumMeasure, rhs.maximumMeasure)) {
return false;
}
return true;
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-equalshashcode
*
*/
@Override
public int hashCode() {
return new HashCodeGenerator(this).append(attributeID).append(measure).append(description).append(minimumMeasure).append(maximumMeasure).getHashCode();
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-tostring
*
*/
@Override
public String toString() {
return new ToStringGenerator(this).append("attributeID", attributeID).append("measure", measure).append("description", description).append("minimumMeasure", minimumMeasure).append("maximumMeasure", maximumMeasure).toString();
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-list-extension
*
* @param aList
* The new list member to set. May be null.
*/
public void setDescription(
@Nullable
final List aList) {
description = aList;
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-list-extension
*
* @return
* true if at least one item is contained, false otherwise.
*/
public boolean hasDescriptionEntries() {
return (!getDescription().isEmpty());
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-list-extension
*
* @return
* true if no item is contained, false otherwise.
*/
public boolean hasNoDescriptionEntries() {
return getDescription().isEmpty();
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-list-extension
*
* @return
* The number of contained elements. Always ≥ 0.
*/
@Nonnegative
public int getDescriptionCount() {
return getDescription().size();
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-list-extension
*
* @param index
* The index to retrieve
* @return
* The element at the specified index. May be null
* @throws ArrayIndexOutOfBoundsException
* if the index is invalid!
*/
@Nullable
public DescriptionType getDescriptionAtIndex(
@Nonnegative
final int index) {
return getDescription().get(index);
}
/**
* Special setter with value of type String
* Created by phloc-ubl-jaxb-plugin -Xphloc-ubl-value
*
* @param valueParam
* The value to be set. May be null.
* @return
* The created intermediary object of type AttributeIDType and never null
*/
@Nonnull
public AttributeIDType setAttributeID(
@Nullable
final String valueParam) {
AttributeIDType aObj = getAttributeID();
if (aObj == null) {
aObj = new AttributeIDType(valueParam);
setAttributeID(aObj);
} else {
aObj.setValue(valueParam);
}
return aObj;
}
/**
* Special setter with value of type BigDecimal
* Created by phloc-ubl-jaxb-plugin -Xphloc-ubl-value
*
* @param valueParam
* The value to be set. May be null.
* @return
* The created intermediary object of type MeasureType and never null
*/
@Nonnull
public MeasureType setMeasure(
@Nullable
final BigDecimal valueParam) {
MeasureType aObj = getMeasure();
if (aObj == null) {
aObj = new MeasureType(valueParam);
setMeasure(aObj);
} else {
aObj.setValue(valueParam);
}
return aObj;
}
/**
* Special setter with value of type BigDecimal
* Created by phloc-ubl-jaxb-plugin -Xphloc-ubl-value
*
* @param valueParam
* The value to be set. May be null.
* @return
* The created intermediary object of type MinimumMeasureType and never null
*/
@Nonnull
public MinimumMeasureType setMinimumMeasure(
@Nullable
final BigDecimal valueParam) {
MinimumMeasureType aObj = getMinimumMeasure();
if (aObj == null) {
aObj = new MinimumMeasureType(valueParam);
setMinimumMeasure(aObj);
} else {
aObj.setValue(valueParam);
}
return aObj;
}
/**
* Special setter with value of type BigDecimal
* Created by phloc-ubl-jaxb-plugin -Xphloc-ubl-value
*
* @param valueParam
* The value to be set. May be null.
* @return
* The created intermediary object of type MaximumMeasureType and never null
*/
@Nonnull
public MaximumMeasureType setMaximumMeasure(
@Nullable
final BigDecimal valueParam) {
MaximumMeasureType aObj = getMaximumMeasure();
if (aObj == null) {
aObj = new MaximumMeasureType(valueParam);
setMaximumMeasure(aObj);
} else {
aObj.setValue(valueParam);
}
return aObj;
}
/**
* Get the value of the contained AttributeIDType object
* Created by phloc-ubl-jaxb-plugin -Xphloc-ubl-value
*
* @return
* Either the value of the contained AttributeIDType object or null
*/
@Nullable
public String getAttributeIDValue() {
AttributeIDType aObj = getAttributeID();
return ((aObj == null)?null:aObj.getValue());
}
/**
* Get the value of the contained MeasureType object
* Created by phloc-ubl-jaxb-plugin -Xphloc-ubl-value
*
* @return
* Either the value of the contained MeasureType object or null
*/
@Nullable
public BigDecimal getMeasureValue() {
MeasureType aObj = getMeasure();
return ((aObj == null)?null:aObj.getValue());
}
/**
* Get the value of the contained MinimumMeasureType object
* Created by phloc-ubl-jaxb-plugin -Xphloc-ubl-value
*
* @return
* Either the value of the contained MinimumMeasureType object or null
*/
@Nullable
public BigDecimal getMinimumMeasureValue() {
MinimumMeasureType aObj = getMinimumMeasure();
return ((aObj == null)?null:aObj.getValue());
}
/**
* Get the value of the contained MaximumMeasureType object
* Created by phloc-ubl-jaxb-plugin -Xphloc-ubl-value
*
* @return
* Either the value of the contained MaximumMeasureType object or null
*/
@Nullable
public BigDecimal getMaximumMeasureValue() {
MaximumMeasureType aObj = getMaximumMeasure();
return ((aObj == null)?null:aObj.getValue());
}
}