yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/SubmoduleStatementImpl.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;
   9
  10 import static org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator.MAX;
  11 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.findFirstDeclaredSubstatement;
  12 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
  13
  14 import com.google.common.base.Optional;
  15 import java.net.URI;
  16 import java.util.Date;
  17 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
  18 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
  19 import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping;
  20 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.YangVersionStatement;
  25 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleIdentifierImpl;
  26 import org.opendaylight.yangtools.yang.parser.spi.SubmoduleNamespace;
  27 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  31 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleName;
  32 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  33 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.SubmoduleEffectiveStatementImpl;
  34
  35 public class SubmoduleStatementImpl extends AbstractRootStatement<SubmoduleStatement> implements SubmoduleStatement {
  36     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(Rfc6020Mapping
  37             .SUBMODULE)
  38             .add(Rfc6020Mapping.ANYXML, 0, MAX)
  39             .add(Rfc6020Mapping.AUGMENT, 0, MAX)
  40             .add(Rfc6020Mapping.BELONGS_TO, 1, 1)
  41             .add(Rfc6020Mapping.CHOICE, 0, MAX)
  42             .add(Rfc6020Mapping.CONTACT, 0, 1)
  43             .add(Rfc6020Mapping.CONTAINER, 0, MAX)
  44             .add(Rfc6020Mapping.DESCRIPTION, 0, 1)
  45             .add(Rfc6020Mapping.DEVIATION, 0, MAX)
  46             .add(Rfc6020Mapping.EXTENSION, 0, MAX)
  47             .add(Rfc6020Mapping.FEATURE, 0, MAX)
  48             .add(Rfc6020Mapping.GROUPING, 0, MAX)
  49             .add(Rfc6020Mapping.IDENTITY, 0, MAX)
  50             .add(Rfc6020Mapping.IMPORT, 0, MAX)
  51             .add(Rfc6020Mapping.INCLUDE, 0, MAX)
  52             .add(Rfc6020Mapping.LEAF, 0, MAX)
  53             .add(Rfc6020Mapping.LEAF_LIST, 0, MAX)
  54             .add(Rfc6020Mapping.LIST, 0, MAX)
  55             .add(Rfc6020Mapping.NOTIFICATION, 0, MAX)
  56             .add(Rfc6020Mapping.ORGANIZATION, 0, 1)
  57             .add(Rfc6020Mapping.REFERENCE, 0, 1)
  58             .add(Rfc6020Mapping.REVISION, 0, MAX)
  59             .add(Rfc6020Mapping.RPC, 0, MAX)
  60             .add(Rfc6020Mapping.TYPEDEF, 0, MAX)
  61             .add(Rfc6020Mapping.USES, 0, MAX)
  62             .add(Rfc6020Mapping.YANG_VERSION, 0, 1)
  63             .build();
  64
  65     protected SubmoduleStatementImpl(StmtContext<String, SubmoduleStatement, ?> context) {
  66         super(context);
  67     }
  68
  69     public static class Definition extends AbstractStatementSupport<String, SubmoduleStatement,
  70             EffectiveStatement<String, SubmoduleStatement>> {
  71
  72         public Definition() {
  73             super(Rfc6020Mapping.SUBMODULE);
  74         }
  75
  76         @Override
  77         public String parseArgumentValue(StmtContext<?, ?, ?> ctx, String value) {
  78             return value;
  79         }
  80
  81         @Override
  82         public SubmoduleStatement createDeclared(
  83                 StmtContext<String, SubmoduleStatement, ?> ctx) {
  84             return new SubmoduleStatementImpl(ctx);
  85         }
  86
  87         @Override
  88         public EffectiveStatement<String, SubmoduleStatement> createEffective(
  89                 StmtContext<String, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>> ctx) {
  90             return new SubmoduleEffectiveStatementImpl(ctx);
  91         }
  92
  93         @Override
  94         public void onLinkageDeclared(
  95                 Mutable<String, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>> stmt)
  96                 throws SourceException {
  97
  98             Optional<Date> revisionDate = Optional.fromNullable(Utils.getLatestRevision(stmt.declaredSubstatements()));
  99             if (!revisionDate.isPresent()) {
 100                 revisionDate = Optional.of(SimpleDateFormatUtil.DEFAULT_DATE_REV);
 101             }
 102
 103             ModuleIdentifier submoduleIdentifier = new ModuleIdentifierImpl(
 104                     stmt.getStatementArgument(), Optional.<URI> absent(),
 105                     revisionDate);
 106
 107             stmt.addContext(SubmoduleNamespace.class, submoduleIdentifier, stmt);
 108
 109             String belongsToModuleName = firstAttributeOf(
 110                     stmt.declaredSubstatements(), BelongsToStatement.class);
 111             StmtContext<?, ?, ?> prefixSubStmtCtx = findFirstDeclaredSubstatement(
 112                     stmt, 0, BelongsToStatement.class, PrefixStatement.class);
 113
 114             if (prefixSubStmtCtx == null) {
 115                 throw new SourceException(String.format("Prefix of belongsTo statement is missing in submodule [%s]",
 116                         stmt.getStatementArgument()), stmt.getStatementSourceReference());
 117             }
 118
 119             String prefix = (String) prefixSubStmtCtx.getStatementArgument();
 120
 121             stmt.addToNs(BelongsToPrefixToModuleName.class, prefix,
 122                     belongsToModuleName);
 123         }
 124
 125         @Override
 126         public void onFullDefinitionDeclared(Mutable<String, SubmoduleStatement,
 127                 EffectiveStatement<String, SubmoduleStatement>> stmt) throws SourceException {
 128             super.onFullDefinitionDeclared(stmt);
 129             SUBSTATEMENT_VALIDATOR.validate(stmt);
 130         }
 131     }
 132
 133     @Override
 134     public String getName() {
 135         return rawArgument();
 136     }
 137
 138     @Override
 139     public YangVersionStatement getYangVersion() {
 140         return firstDeclared(YangVersionStatement.class);
 141     }
 142
 143     @Override
 144     public BelongsToStatement getBelongsTo() {
 145         return firstDeclared(BelongsToStatement.class);
 146     }
 147
 148 }