oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2

Class MeterType

java.lang.Object

oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2.MeterType

public class MeterType
extends Object

 <?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:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                <ccts:ComponentType>ABIE</ccts:ComponentType>
                <ccts:DictionaryEntryName>Meter. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to describe a meter and its readings.</ccts:Definition>
                <ccts:ObjectClass>Meter</ccts:ObjectClass>
             </ccts:Component>
 

Java class for MeterType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="MeterType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}MeterNumber" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}MeterName" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}MeterConstant" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}MeterConstantCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TotalDeliveredQuantity" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}MeterReading" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}MeterProperty" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected MeterConstantType	meterConstant
protected MeterConstantCodeType	meterConstantCode
protected MeterNameType	meterName
protected MeterNumberType	meterNumber
protected List<MeterPropertyType>	meterProperty
protected List<MeterReadingType>	meterReading
protected TotalDeliveredQuantityType	totalDeliveredQuantity

Constructor Summary

Constructors

Constructor and Description
MeterType()

Method Summary

Modifier and Type	Method and Description
MeterConstantType	getMeterConstant() <?
MeterConstantCodeType	getMeterConstantCode() <?
MeterNameType	getMeterName() <?
MeterNumberType	getMeterNumber() <?
List<MeterPropertyType>	getMeterProperty() <?
List<MeterReadingType>	getMeterReading() <?
TotalDeliveredQuantityType	getTotalDeliveredQuantity() <?
void	setMeterConstant(MeterConstantType value) Sets the value of the meterConstant property.
void	setMeterConstantCode(MeterConstantCodeType value) Sets the value of the meterConstantCode property.
void	setMeterName(MeterNameType value) Sets the value of the meterName property.
void	setMeterNumber(MeterNumberType value) Sets the value of the meterNumber property.
void	setTotalDeliveredQuantity(TotalDeliveredQuantityType value) Sets the value of the totalDeliveredQuantity property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

meterNumber

protected MeterNumberType meterNumber

meterName

protected MeterNameType meterName

meterConstant

protected MeterConstantType meterConstant

meterConstantCode

protected MeterConstantCodeType meterConstantCode

totalDeliveredQuantity

protected TotalDeliveredQuantityType totalDeliveredQuantity

meterReading

protected List<MeterReadingType> meterReading

meterProperty

protected List<MeterPropertyType> meterProperty

Constructor Detail

MeterType

public MeterType()

Method Detail

getMeterNumber

public MeterNumberType getMeterNumber()

 <?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:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                      <ccts:ComponentType>BBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Meter. Meter Number. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>The meter number, expressed as text.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Meter</ccts:ObjectClass>
                      <ccts:PropertyTerm>Meter Number</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                      <ccts:Examples>61722x</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is MeterNumberType

setMeterNumber

public void setMeterNumber(MeterNumberType value)

Sets the value of the meterNumber property.

Parameters:

value - allowed object is MeterNumberType

getMeterName

public MeterNameType getMeterName()

 <?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:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                      <ccts:ComponentType>BBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Meter. Meter Name. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>The name of this meter, which serves as an identifier to distinguish a main meter from a submeter.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Meter</ccts:ObjectClass>
                      <ccts:PropertyTerm>Meter Name</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is MeterNameType

setMeterName

public void setMeterName(MeterNameType value)

Sets the value of the meterName property.

Parameters:

value - allowed object is MeterNameType

getMeterConstant

public MeterConstantType getMeterConstant()

 <?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:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                      <ccts:ComponentType>BBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Meter. Meter Constant. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>The factor by which readings of this meter must be multiplied to calculate consumption, expressed as text.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Meter</ccts:ObjectClass>
                      <ccts:PropertyTerm>Meter Constant</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                      <ccts:Examples>1.000</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is MeterConstantType

setMeterConstant

public void setMeterConstant(MeterConstantType value)

Sets the value of the meterConstant property.

Parameters:

value - allowed object is MeterConstantType

getMeterConstantCode

public MeterConstantCodeType getMeterConstantCode()

 <?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:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                      <ccts:ComponentType>BBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Meter. Meter Constant Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>A code signifying the formula to be used in applying the meter constant.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Meter</ccts:ObjectClass>
                      <ccts:PropertyTerm>Meter Constant Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataType>Code. Type</ccts:DataType>
                      <ccts:Examples>Factor</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is MeterConstantCodeType

setMeterConstantCode

public void setMeterConstantCode(MeterConstantCodeType value)

Sets the value of the meterConstantCode property.

Parameters:

value - allowed object is MeterConstantCodeType

getTotalDeliveredQuantity

public TotalDeliveredQuantityType getTotalDeliveredQuantity()

 <?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:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                      <ccts:ComponentType>BBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Meter. Total_ Delivered Quantity. Quantity</ccts:DictionaryEntryName>
                      <ccts:Definition>The quantity delivered; the total quantity consumed as calculated from the meter readings.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Meter</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Total</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Delivered Quantity</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Quantity</ccts:RepresentationTerm>
                      <ccts:DataType>Quantity. Type</ccts:DataType>
                      <ccts:Examples>5761.00</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is TotalDeliveredQuantityType

setTotalDeliveredQuantity

public void setTotalDeliveredQuantity(TotalDeliveredQuantityType value)

Sets the value of the totalDeliveredQuantity property.

Parameters:

value - allowed object is TotalDeliveredQuantityType

getMeterReading

public List<MeterReadingType> getMeterReading()

 <?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:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                      <ccts:ComponentType>ASBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Meter. Meter Reading</ccts:DictionaryEntryName>
                      <ccts:Definition>A reading of this meter.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Meter</ccts:ObjectClass>
                      <ccts:PropertyTerm>Meter Reading</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Meter Reading</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Meter Reading</ccts:RepresentationTerm>
                   </ccts:Component>
 

Gets the value of the meterReading 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 meterReading property.

For example, to add a new item, do as follows:

    getMeterReading().add(newItem);
 

Objects of the following type(s) are allowed in the list MeterReadingType

getMeterProperty

public List<MeterPropertyType> getMeterProperty()

 <?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:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                      <ccts:ComponentType>ASBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Meter. Meter Property</ccts:DictionaryEntryName>
                      <ccts:Definition>A property of this meter.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Meter</ccts:ObjectClass>
                      <ccts:PropertyTerm>Meter Property</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Meter Property</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Meter Property</ccts:RepresentationTerm>
                   </ccts:Component>
 

Gets the value of the meterProperty 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 meterProperty property.

For example, to add a new item, do as follows:

    getMeterProperty().add(newItem);
 

Objects of the following type(s) are allowed in the list MeterPropertyType