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