Bug 6897: Adding getSubstatementValidator() method to AbstractStatementSupport
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / rfc6020 / AnyxmlStatementImpl.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.util.Collection;
12 import java.util.Map;
13 import javax.annotation.Nonnull;
14 import org.opendaylight.yangtools.yang.common.QName;
15 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
16 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
17 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
18 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
19 import org.opendaylight.yangtools.yang.model.api.stmt.AnyxmlStatement;
20 import org.opendaylight.yangtools.yang.model.api.stmt.ConfigStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.MandatoryStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.MustStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
26 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
27 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
28 import org.opendaylight.yangtools.yang.model.api.stmt.UnknownStatement;
29 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
30 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
35 import org.opendaylight.yangtools.yang.parser.spi.source.AnyxmlSchemaLocationNamespace;
36 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
37 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.AnyXmlEffectiveStatementImpl;
38 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.YangModeledAnyXmlEffectiveStatementImpl;
39
40 public class AnyxmlStatementImpl extends AbstractDeclaredStatement<QName> implements AnyxmlStatement {
41     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
42             .ANYXML)
43             .addOptional(YangStmtMapping.CONFIG)
44             .addOptional(YangStmtMapping.DESCRIPTION)
45             .addAny(YangStmtMapping.IF_FEATURE)
46             .addOptional(YangStmtMapping.MANDATORY)
47             .addAny(YangStmtMapping.MUST)
48             .addOptional(YangStmtMapping.REFERENCE)
49             .addOptional(YangStmtMapping.STATUS)
50             .addOptional(YangStmtMapping.WHEN)
51             .addOptional(SupportedExtensionsMapping.ANYXML_SCHEMA_LOCATION)
52             .build();
53
54     protected AnyxmlStatementImpl(final StmtContext<QName, AnyxmlStatement, ?> context) {
55         super(context);
56     }
57
58     public static class Definition extends
59             AbstractStatementSupport<QName, AnyxmlStatement, EffectiveStatement<QName, AnyxmlStatement>> {
60
61         public Definition() {
62             super(YangStmtMapping.ANYXML);
63         }
64
65         @Override
66         public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
67             return Utils.qNameFromArgument(ctx, value);
68         }
69
70         @Override
71         public void onStatementAdded(final Mutable<QName, AnyxmlStatement, EffectiveStatement<QName, AnyxmlStatement>> stmt) {
72             stmt.getParentContext().addToNs(ChildSchemaNodes.class, stmt.getStatementArgument(), stmt);
73         }
74
75         @Override
76         public AnyxmlStatement createDeclared(final StmtContext<QName, AnyxmlStatement, ?> ctx) {
77             return new AnyxmlStatementImpl(ctx);
78         }
79
80         @Override
81         public EffectiveStatement<QName, AnyxmlStatement> createEffective(
82                 final StmtContext<QName, AnyxmlStatement, EffectiveStatement<QName, AnyxmlStatement>> ctx) {
83             final Map<StatementDefinition, Mutable<SchemaNodeIdentifier, UnknownStatement<SchemaNodeIdentifier>, EffectiveStatement<SchemaNodeIdentifier, UnknownStatement<SchemaNodeIdentifier>>>> schemaLocations = ctx
84                     .getAllFromCurrentStmtCtxNamespace(AnyxmlSchemaLocationNamespace.class);
85             if (schemaLocations != null && !schemaLocations.isEmpty()) {
86                 final SchemaNodeIdentifier anyXmlSchemaNodeIdentifier = schemaLocations.values().iterator().next()
87                         .getStatementArgument();
88                 final Optional<ContainerSchemaNode> anyXmlSchema = getAnyXmlSchema(ctx, anyXmlSchemaNodeIdentifier);
89                 if (anyXmlSchema.isPresent()) {
90                     return new YangModeledAnyXmlEffectiveStatementImpl(ctx, anyXmlSchema.get());
91                 }
92             }
93             return new AnyXmlEffectiveStatementImpl(ctx);
94         }
95
96         @Override
97         public void onFullDefinitionDeclared(final Mutable<QName, AnyxmlStatement,
98                 EffectiveStatement<QName, AnyxmlStatement>> stmt) {
99             super.onFullDefinitionDeclared(stmt);
100             getSubstatementValidator().validate(stmt);
101         }
102
103         private Optional<ContainerSchemaNode> getAnyXmlSchema(
104                 final StmtContext<QName, AnyxmlStatement, EffectiveStatement<QName, AnyxmlStatement>> ctx,
105                 final SchemaNodeIdentifier contentSchemaPath) {
106             final StatementContextBase<?, ?, ?> findNode = Utils.findNode(ctx.getRoot(), contentSchemaPath);
107             if (findNode != null) {
108                 final EffectiveStatement<?, ?> anyXmlSchemaNode = findNode.buildEffective();
109                 if (anyXmlSchemaNode instanceof ContainerSchemaNode) {
110                     return Optional.of((ContainerSchemaNode) anyXmlSchemaNode);
111                 }
112             }
113             return Optional.absent();
114         }
115
116         @Override
117         protected SubstatementValidator getSubstatementValidator() {
118             return SUBSTATEMENT_VALIDATOR;
119         }
120     }
121
122     @Nonnull
123     @Override
124     public QName getName() {
125         return argument();
126     }
127
128     @Override
129     public WhenStatement getWhenStatement() {
130         return firstDeclared(WhenStatement.class);
131     }
132
133     @Nonnull
134     @Override
135     public Collection<? extends IfFeatureStatement> getIfFeatures() {
136         return allDeclared(IfFeatureStatement.class);
137     }
138
139     @Nonnull
140     @Override
141     public Collection<? extends MustStatement> getMusts() {
142         return allDeclared(MustStatement.class);
143     }
144
145     @Override
146     public ConfigStatement getConfig() {
147         return firstDeclared(ConfigStatement.class);
148     }
149
150     @Override
151     public StatusStatement getStatus() {
152         return firstDeclared(StatusStatement.class);
153     }
154
155     @Override
156     public DescriptionStatement getDescription() {
157         return firstDeclared(DescriptionStatement.class);
158     }
159
160     @Override
161     public ReferenceStatement getReference() {
162         return firstDeclared(ReferenceStatement.class);
163     }
164
165     @Override
166     public MandatoryStatement getMandatory() {
167         return firstDeclared(MandatoryStatement.class);
168     }
169
170 }