Introduce formatting methods for SourceException
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / rfc6020 / BelongsToStatementImpl.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 com.google.common.base.Optional;
11 import java.net.URI;
12 import java.util.Collection;
13 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
14 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
15 import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping;
16 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
17 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
18 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
19 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleIdentifierImpl;
20 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
21 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
22 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
23 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
24 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
25 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
26 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
27 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
29 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToModuleContext;
30 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleIdentifier;
31 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNamespaceForBelongsTo;
32 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.BelongsEffectiveToStatementImpl;
33
34 public class BelongsToStatementImpl extends AbstractDeclaredStatement<String>
35         implements BelongsToStatement {
36     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
37             SubstatementValidator.builder(Rfc6020Mapping.BELONGS_TO).add(Rfc6020Mapping.PREFIX, 1, 1).build();
38
39     protected BelongsToStatementImpl(final StmtContext<String, BelongsToStatement, ?> context) {
40         super(context);
41     }
42
43     public static class Definition
44             extends
45             AbstractStatementSupport<String, BelongsToStatement, EffectiveStatement<String, BelongsToStatement>> {
46
47         public Definition() {
48             super(Rfc6020Mapping.BELONGS_TO);
49         }
50
51         @Override
52         public String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
53             return value;
54         }
55
56         @Override
57         public BelongsToStatement createDeclared(
58                 final StmtContext<String, BelongsToStatement, ?> ctx) {
59             return new BelongsToStatementImpl(ctx);
60         }
61
62         @Override
63         public EffectiveStatement<String, BelongsToStatement> createEffective(
64                 final StmtContext<String, BelongsToStatement, EffectiveStatement<String, BelongsToStatement>> ctx) {
65             return new BelongsEffectiveToStatementImpl(ctx);
66         }
67
68         @Override
69         public void onLinkageDeclared(
70                 final StmtContext.Mutable<String, BelongsToStatement, EffectiveStatement<String, BelongsToStatement>> belongsToCtx) {
71             ModelActionBuilder belongsToAction = belongsToCtx.newInferenceAction(ModelProcessingPhase.SOURCE_LINKAGE);
72
73             final ModuleIdentifier belongsToModuleIdentifier = getModuleIdentifier(belongsToCtx);
74             final ModelActionBuilder.Prerequisite<StmtContext<?, ?, ?>> belongsToPrereq = belongsToAction.requiresCtx(
75                 belongsToCtx, ModuleNamespaceForBelongsTo.class, belongsToModuleIdentifier.getName(),
76                 ModelProcessingPhase.SOURCE_LINKAGE);
77
78             belongsToAction.apply(new InferenceAction() {
79                 @Override
80                 public void apply() {
81                     StmtContext<?, ?, ?> belongsToModuleCtx = belongsToPrereq.get();
82
83                     belongsToCtx.addToNs(BelongsToModuleContext.class, belongsToModuleIdentifier, belongsToModuleCtx);
84                     belongsToCtx.addToNs(BelongsToPrefixToModuleIdentifier.class,
85                         StmtContextUtils.findFirstDeclaredSubstatement(belongsToCtx, PrefixStatement.class)
86                         .getStatementArgument(), belongsToModuleIdentifier);
87                 }
88
89                 @Override
90                 public void prerequisiteFailed(final Collection<? extends ModelActionBuilder.Prerequisite<?>> failed) {
91                     if (failed.contains(belongsToPrereq)) {
92                         throw new InferenceException(belongsToCtx.getStatementSourceReference(),
93                             "Module '%s' from belongs-to was not found", belongsToCtx.getStatementArgument());
94                     }
95                 }
96             });
97         }
98
99         private static ModuleIdentifier getModuleIdentifier(
100                 final StmtContext.Mutable<String, BelongsToStatement, EffectiveStatement<String, BelongsToStatement>> belongsToCtx) {
101             String moduleName = belongsToCtx.getStatementArgument();
102             return new ModuleIdentifierImpl(moduleName, Optional.<URI> absent(),
103                 Optional.of(SimpleDateFormatUtil.DEFAULT_BELONGS_TO_DATE));
104         }
105
106         @Override
107         public void onFullDefinitionDeclared(final StmtContext.Mutable<String, BelongsToStatement,
108                 EffectiveStatement<String, BelongsToStatement>> stmt) {
109             super.onFullDefinitionDeclared(stmt);
110             SUBSTATEMENT_VALIDATOR.validate(stmt);
111         }
112     }
113
114     @Override
115     public String getModule() {
116         return argument();
117     }
118
119     @Override
120     public PrefixStatement getPrefix() {
121         return firstDeclared(PrefixStatement.class);
122     }
123
124 }