1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.apex.model.basicmodel.handling;
import java.io.File;
import java.io.FileOutputStream;
import org.onap.apex.model.basicmodel.concepts.ApexException;
import org.onap.apex.model.basicmodel.concepts.AxModel;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/**
* This class writes an Apex model to a file.
*
* @author Liam Fallon (liam.fallon@ericsson.com)
* @param <M> the type of Apex model to write to file, must be a sub class of {@link AxModel}
*/
public class ApexModelFileWriter<M extends AxModel> {
private static final XLogger LOGGER = XLoggerFactory.getXLogger(ApexModelFileWriter.class);
// Should models being written to files be valid
private boolean validateFlag;
/**
* Constructor, set the validation flag.
*
* @param validateFlag indicates if validation be performed prior to output
*/
public ApexModelFileWriter(final boolean validateFlag) {
this.validateFlag = validateFlag;
}
/**
* Write a model to an XML file.
*
* @param model The model to write
* @param rootModelClass The concept class
* @param modelFileName The name of the file to write to
* @throws ApexException thrown on errors
*/
public void apexModelWriteXMLFile(final M model, final Class<M> rootModelClass, final String modelFileName)
throws ApexException {
LOGGER.debug("running apexModelWriteXMLFile . . .");
final ApexModelWriter<M> modelWriter = new ApexModelWriter<>(rootModelClass);
modelWriter.setValidateFlag(validateFlag);
modelWriter.getCDataFieldSet().add("description");
modelWriter.getCDataFieldSet().add("logic");
modelWriter.getCDataFieldSet().add("uiLogic");
writeModelFile(model, modelWriter, modelFileName);
LOGGER.debug("ran apexModelWriteXMLFile");
}
/**
* Write a model to an JSON file.
*
* @param model The model to write
* @param rootModelClass The concept class
* @param modelFileName The name of the file to write to
* @throws ApexException thrown on errors
*/
public void apexModelWriteJSONFile(final M model, final Class<M> rootModelClass, final String modelFileName)
throws ApexException {
LOGGER.debug("running apexModelWriteJSONFile . . .");
final ApexModelWriter<M> modelWriter = new ApexModelWriter<>(rootModelClass);
modelWriter.setJsonOutput(true);
modelWriter.setValidateFlag(validateFlag);
writeModelFile(model, modelWriter, modelFileName);
LOGGER.debug("ran apexModelWriteJSONFile");
}
/**
* Checks if the validation flag is set.
*
* @return true, the validation flag is set
*/
public boolean isValidateFlag() {
return validateFlag;
}
/**
* Sets the validate flag.
*
* @param validateFlag the validate flag value
*/
public void setValidateFlag(final boolean validateFlag) {
this.validateFlag = validateFlag;
}
/**
* Write a model to a file using a model writer.
*
* @param model The model to write
* @param modelWriter the model writer to use to write the model to the file
* @param modelFileName the file name of the file to write to
* @throws ApexException on exceptions writing the model
*/
private void writeModelFile(final M model, final ApexModelWriter<M> modelWriter, final String modelFileName) throws ApexException {
final File modelFile = new File(modelFileName);
if (!modelFile.getParentFile().exists() && !modelFile.getParentFile().mkdirs()) {
LOGGER.warn("could not create directory " + modelFile.getParentFile());
throw new ApexException("could not create directory " + modelFile.getParentFile());
}
try {
final FileOutputStream fileOutputStream = new FileOutputStream(modelFile);
modelWriter.write(model, fileOutputStream);
fileOutputStream.close();
}
catch (final Exception e) {
LOGGER.warn("error processing file " + modelFile.getAbsolutePath(), e);
throw new ApexException("error processing file " + modelFile.getAbsolutePath(), e);
}
}
}
|
