yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/effective/type/Decimal64SpecificationEffectiveStatementImpl.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.type;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.collect.ImmutableList;
  12 import java.math.BigDecimal;
  13 import java.util.Collections;
  14 import java.util.List;
  15 import java.util.Objects;
  16 import org.opendaylight.yangtools.yang.common.QName;
  17 import org.opendaylight.yangtools.yang.common.YangConstants;
  18 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  19 import org.opendaylight.yangtools.yang.model.api.Status;
  20 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  21 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  22 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.TypeEffectiveStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.TypeStatement.Decimal64Specification;
  25 import org.opendaylight.yangtools.yang.model.api.type.DecimalTypeDefinition;
  26 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
  27 import org.opendaylight.yangtools.yang.model.util.Decimal64;
  28 import org.opendaylight.yangtools.yang.model.util.ExtendedType;
  29 import org.opendaylight.yangtools.yang.model.util.ExtendedType.Builder;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  31 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.TypeUtils;
  32 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.Utils;
  33 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.EffectiveStatementBase;
  34 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.FractionDigitsEffectiveStatementImpl;
  35
  36 public class Decimal64SpecificationEffectiveStatementImpl extends
  37         EffectiveStatementBase<String, Decimal64Specification>
  38         implements DecimalTypeDefinition, TypeEffectiveStatement<Decimal64Specification> {
  39
  40     private static final String UNITS = "";
  41     private static final BigDecimal DEFAULT_VALUE = null;
  42     private static final QName QNAME = QName.create(YangConstants.RFC6020_YANG_MODULE, TypeUtils.DECIMAL64);
  43
  44     private static final String DESCRIPTION = "The decimal64 type represents a subset of the real numbers, which can "
  45             + "be represented by decimal numerals. The value space of decimal64 is the set of numbers that can "
  46             + "be obtained by multiplying a 64-bit signed integer by a negative power of ten, i.e., expressible as "
  47             + "'i x 10^-n' where i is an integer64 and n is an integer between 1 and 18, inclusively.";
  48
  49     private static final String REFERENCE = "https://tools.ietf.org/html/rfc6020#section-9.3";
  50     private static final BigDecimal MIN_VALUE = new BigDecimal("-922337203685477580.8");
  51     private static final BigDecimal MAX_VALUE = new BigDecimal("922337203685477580.7");
  52     private static final List<RangeConstraint> DEFAULT_RANGE_STATEMENTS;
  53     static {
  54         final String rangeDescription = "Integer values between " + MIN_VALUE
  55                 + " and " + MAX_VALUE + ", inclusively.";
  56         final String rangeReference = RangeConstraintEffectiveImpl.DEFAULT_REFERENCE;
  57
  58         DEFAULT_RANGE_STATEMENTS = ImmutableList.<RangeConstraint>of(
  59                 new RangeConstraintEffectiveImpl(MIN_VALUE, MAX_VALUE, Optional.of(rangeDescription),
  60                 Optional.of(rangeReference)));
  61     }
  62
  63     private List<RangeConstraint> rangeConstraints;
  64     private Integer fractionDigits;
  65     private SchemaPath path;
  66     private QName extendedTypeQName;
  67
  68     private ExtendedType extendedType;
  69     private final boolean isExtended;
  70     private Decimal64 decimal64Instance = null;
  71
  72     public Decimal64SpecificationEffectiveStatementImpl(
  73             final StmtContext<String, Decimal64Specification, EffectiveStatement<String, Decimal64Specification>> ctx) {
  74         super(ctx);
  75
  76         for (final EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements()) {
  77             if (effectiveStatement instanceof FractionDigitsEffectiveStatementImpl) {
  78                 fractionDigits = ((FractionDigitsEffectiveStatementImpl) effectiveStatement)
  79                         .argument();
  80             }
  81         }
  82
  83         List<RangeConstraint> initRanges = initRanges();
  84
  85         if (!initRanges.isEmpty() && validateRanges(initRanges)) {
  86             isExtended = true;
  87             rangeConstraints = ImmutableList.copyOf(initRanges);
  88             SchemaPath parentPath = Utils.getSchemaPath(ctx.getParentContext());
  89             extendedTypeQName = QName.create(parentPath.getLastComponent().getModule(), QNAME.getLocalName());
  90             path = parentPath.createChild(extendedTypeQName);
  91         } else {
  92             isExtended = false;
  93             rangeConstraints = DEFAULT_RANGE_STATEMENTS;
  94             path = Utils.getSchemaPath(ctx.getParentContext()).createChild(QNAME);
  95         }
  96     }
  97
  98     private static boolean validateRanges(final List<RangeConstraint> initRanges) {
  99         for (RangeConstraint rangeConstraint : initRanges) {
 100
 101             String maxValueString = rangeConstraint.getMax().toString();
 102             String minValueString = rangeConstraint.getMin().toString();
 103
 104             if ((!"max".equals(maxValueString) && MAX_VALUE.compareTo(new BigDecimal(maxValueString)) < 0)
 105                     || (!"min".equals(minValueString) && MIN_VALUE.compareTo(new BigDecimal(minValueString)) > 0)) {
 106                 return false;
 107             }
 108         }
 109         return true;
 110     }
 111
 112     private List<RangeConstraint> initRanges() {
 113         final RangeEffectiveStatementImpl rangeConstraintsStmt = firstEffective(RangeEffectiveStatementImpl.class);
 114         return rangeConstraintsStmt != null ? rangeConstraintsStmt.argument() : Collections.<RangeConstraint> emptyList();
 115     }
 116
 117     public boolean isExtended() {
 118         return isExtended;
 119     }
 120
 121     @Override
 122     public List<RangeConstraint> getRangeConstraints() {
 123         return rangeConstraints;
 124     }
 125
 126     @Override
 127     public Integer getFractionDigits() {
 128         return fractionDigits;
 129     }
 130
 131     @Override
 132     public DecimalTypeDefinition getBaseType() {
 133         if (isExtended) {
 134             if (decimal64Instance == null) {
 135                 decimal64Instance = Decimal64.create(path, fractionDigits);
 136             }
 137             return decimal64Instance;
 138         } else {
 139             return null;
 140         }
 141     }
 142
 143     @Override
 144     public String getUnits() {
 145         return UNITS;
 146     }
 147
 148     @Override
 149     public Object getDefaultValue() {
 150         return DEFAULT_VALUE;
 151     }
 152
 153     @Override
 154     public QName getQName() {
 155         return QNAME;
 156     }
 157
 158     @Override
 159     public SchemaPath getPath() {
 160         return path;
 161     }
 162
 163     @Override
 164     public List<UnknownSchemaNode> getUnknownSchemaNodes() {
 165         return Collections.emptyList();
 166     }
 167
 168     @Override
 169     public String getDescription() {
 170         return DESCRIPTION;
 171     }
 172
 173     @Override
 174     public String getReference() {
 175         return REFERENCE;
 176     }
 177
 178     @Override
 179     public Status getStatus() {
 180         return Status.CURRENT;
 181     }
 182
 183     @Override
 184     public int hashCode() {
 185         final int prime = 31;
 186         int result = 1;
 187         result = prime * result + Objects.hashCode(QNAME);
 188         result = prime * result + Objects.hashCode(path);
 189         return result;
 190     }
 191
 192     @Override
 193     public boolean equals(final Object obj) {
 194         if (this == obj) {
 195             return true;
 196         }
 197         if (obj == null) {
 198             return false;
 199         }
 200         if (getClass() != obj.getClass()) {
 201             return false;
 202         }
 203         Decimal64SpecificationEffectiveStatementImpl other = (Decimal64SpecificationEffectiveStatementImpl) obj;
 204         return Objects.equals(path, other.path);
 205     }
 206
 207     @Override
 208     public String toString() {
 209         return Decimal64SpecificationEffectiveStatementImpl.class.getSimpleName()
 210                 + "[qName=" + QNAME + ", fractionDigits=" + fractionDigits + "]";
 211     }
 212
 213     @Override
 214     public TypeDefinition<?> getTypeDefinition() {
 215
 216         if (decimal64Instance == null) {
 217             decimal64Instance = Decimal64.create(path, fractionDigits);
 218         }
 219
 220         if (!isExtended) {
 221             return decimal64Instance;
 222         }
 223
 224         if (extendedType != null) {
 225             return extendedType;
 226         }
 227
 228         Builder extendedTypeBuilder = ExtendedType.builder(path.getLastComponent(), decimal64Instance,
 229             Optional.<String>absent(), Optional.<String>absent(), path);
 230
 231         extendedTypeBuilder.fractionDigits(fractionDigits);
 232         extendedTypeBuilder.ranges(rangeConstraints);
 233
 234         extendedType = extendedTypeBuilder.build();
 235
 236         return extendedType;
 237     }
 238 }