yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/ModuleStatementSupport.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.firstAttributeOf;
  12
  13 import com.google.common.base.Optional;
  14 import java.net.URI;
  15 import java.util.Date;
  16 import org.opendaylight.yangtools.yang.common.QNameModule;
  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.ModuleStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.NamespaceStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  24 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleIdentifierImpl;
  25 import org.opendaylight.yangtools.yang.parser.spi.ModuleNamespace;
  26 import org.opendaylight.yangtools.yang.parser.spi.NamespaceToModule;
  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.ImpPrefixToModuleIdentifier;
  32 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
  33 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleIdentifierToModuleQName;
  34 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNameToModuleQName;
  35 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNamespaceForBelongsTo;
  36 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleQNameToModuleName;
  37 import org.opendaylight.yangtools.yang.parser.spi.source.PrefixToModule;
  38 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  39 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.ModuleEffectiveStatementImpl;
  40
  41 public class ModuleStatementSupport extends
  42         AbstractStatementSupport<String, ModuleStatement, EffectiveStatement<String, ModuleStatement>> {
  43     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(Rfc6020Mapping
  44             .MODULE)
  45             .add(Rfc6020Mapping.ANYXML, 0, MAX)
  46             .add(Rfc6020Mapping.AUGMENT, 0, MAX)
  47             .add(Rfc6020Mapping.CHOICE, 0, MAX)
  48             .add(Rfc6020Mapping.CONTACT, 0, 1)
  49             .add(Rfc6020Mapping.CONTAINER, 0, MAX)
  50             .add(Rfc6020Mapping.DESCRIPTION, 0, 1)
  51             .add(Rfc6020Mapping.DEVIATION, 0, MAX)
  52             .add(Rfc6020Mapping.EXTENSION, 0, MAX)
  53             .add(Rfc6020Mapping.FEATURE, 0, MAX)
  54             .add(Rfc6020Mapping.GROUPING, 0, MAX)
  55             .add(Rfc6020Mapping.IDENTITY, 0, MAX)
  56             .add(Rfc6020Mapping.IMPORT, 0, MAX)
  57             .add(Rfc6020Mapping.INCLUDE, 0, MAX)
  58             .add(Rfc6020Mapping.LEAF, 0, MAX)
  59             .add(Rfc6020Mapping.LEAF_LIST, 0, MAX)
  60             .add(Rfc6020Mapping.LIST, 0, MAX)
  61             .add(Rfc6020Mapping.NAMESPACE, 1, 1)
  62             .add(Rfc6020Mapping.NOTIFICATION, 0, MAX)
  63             .add(Rfc6020Mapping.ORGANIZATION, 0, 1)
  64             .add(Rfc6020Mapping.PREFIX, 1, 1)
  65             .add(Rfc6020Mapping.REFERENCE, 0, 1)
  66             .add(Rfc6020Mapping.REVISION, 0, MAX)
  67             .add(Rfc6020Mapping.RPC, 0, MAX)
  68             .add(Rfc6020Mapping.TYPEDEF, 0, MAX)
  69             .add(Rfc6020Mapping.USES, 0, MAX)
  70             .add(Rfc6020Mapping.YANG_VERSION, 0, 1)
  71             .build();
  72
  73     public ModuleStatementSupport() {
  74         super(Rfc6020Mapping.MODULE);
  75     }
  76
  77     @Override
  78     public String parseArgumentValue(StmtContext<?, ?, ?> ctx, String value) {
  79         return value;
  80     }
  81
  82     @Override
  83     public ModuleStatement createDeclared(StmtContext<String, ModuleStatement, ?> ctx) {
  84         return new ModuleStatementImpl(ctx);
  85     }
  86
  87     @Override
  88     public EffectiveStatement<String, ModuleStatement> createEffective(
  89             StmtContext<String, ModuleStatement, EffectiveStatement<String, ModuleStatement>> ctx) {
  90         return new ModuleEffectiveStatementImpl(ctx);
  91     }
  92
  93     @Override
  94     public void onLinkageDeclared(Mutable<String, ModuleStatement, EffectiveStatement<String, ModuleStatement>> stmt)
  95             throws SourceException {
  96
  97         Optional<URI> moduleNs = Optional.fromNullable(firstAttributeOf(stmt.declaredSubstatements(),
  98                 NamespaceStatement.class));
  99         if (!moduleNs.isPresent()) {
 100             throw new IllegalArgumentException("Namespace of the module [" + stmt.getStatementArgument()
 101                     + "] is missing.");
 102         }
 103
 104         Optional<Date> revisionDate = Optional.fromNullable(Utils.getLatestRevision(stmt.declaredSubstatements()));
 105         if (!revisionDate.isPresent()) {
 106             revisionDate = Optional.of(SimpleDateFormatUtil.DEFAULT_DATE_REV);
 107         }
 108
 109         QNameModule qNameModule = QNameModule.cachedReference(QNameModule.create(moduleNs.get(), revisionDate.orNull()));
 110         ModuleIdentifier moduleIdentifier = new ModuleIdentifierImpl(stmt.getStatementArgument(),
 111                 Optional.<URI> absent(), revisionDate);
 112
 113         stmt.addContext(ModuleNamespace.class, moduleIdentifier, stmt);
 114         stmt.addContext(ModuleNamespaceForBelongsTo.class, moduleIdentifier.getName(), stmt);
 115         stmt.addContext(NamespaceToModule.class, qNameModule, stmt);
 116
 117         String modulePrefix = firstAttributeOf(stmt.declaredSubstatements(), PrefixStatement.class);
 118         if (modulePrefix == null) {
 119             throw new IllegalArgumentException("Prefix of the module [" + stmt.getStatementArgument() + "] is missing.");
 120         }
 121
 122         stmt.addToNs(PrefixToModule.class, modulePrefix, qNameModule);
 123         stmt.addToNs(ModuleNameToModuleQName.class, stmt.getStatementArgument(), qNameModule);
 124         stmt.addToNs(ModuleCtxToModuleQName.class, stmt, qNameModule);
 125         stmt.addToNs(ModuleQNameToModuleName.class, qNameModule, stmt.getStatementArgument());
 126         stmt.addToNs(ModuleIdentifierToModuleQName.class, moduleIdentifier, qNameModule);
 127
 128         stmt.addToNs(ImpPrefixToModuleIdentifier.class, modulePrefix, moduleIdentifier);
 129     }
 130
 131     @Override
 132     public void onFullDefinitionDeclared(Mutable<String, ModuleStatement,
 133             EffectiveStatement<String, ModuleStatement>> stmt) throws SourceException {
 134         super.onFullDefinitionDeclared(stmt);
 135         SUBSTATEMENT_VALIDATOR.validate(stmt);
 136     }
 137 }