vre-modeler/src/org/gcube/vremanagement/vremodeler/impl/util/Util.java

352 lines
16 KiB
Java
Raw Normal View History

package org.gcube.vremanagement.vremodeler.impl.util;
import java.io.StringWriter;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collection;
import java.util.Hashtable;
import java.util.List;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import org.gcube.common.core.utils.logging.GCUBELog;
import org.gcube.vremanagement.vremodeler.db.DBInterface;
import org.gcube.vremanagement.vremodeler.impl.ModelerService;
import org.gcube.vremanagement.vremodeler.impl.ServiceContext;
import org.gcube.vremanagement.vremodeler.resources.MetadataFormat;
import org.gcube.vremanagement.vremodeler.stubs.CollectionType;
import org.gcube.vremanagement.vremodeler.stubs.CollectionTypeInfo;
import org.gcube.vremanagement.vremodeler.stubs.FunctionalityItem;
import org.gcube.vremanagement.vremodeler.stubs.GHNType;
import org.gcube.vremanagement.vremodeler.stubs.GHNTypeMemory;
import org.gcube.vremanagement.vremodeler.stubs.GHNTypeSite;
import org.gcube.vremanagement.vremodeler.stubs.MetadataFormatCollectionRelation;
import org.gcube.vremanagement.vremodeler.stubs.MetadataFormatItem;
import org.gcube.vremanagement.vremodeler.stubs.MetadataFormatRelation;
import org.gcube.vremanagement.vremodeler.stubs.MetadataFormatResponse;
import org.gcube.vremanagement.vremodeler.stubs.Report;
import org.gcube.vremanagement.vremodeler.stubs.RunningInstance;
import org.gcube.vremanagement.vremodeler.stubs.VREDescription;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
/**
*
* @author Lucio Lelii
*
*/
public class Util {
private static final GCUBELog logger = new GCUBELog(ModelerService.class.getName());
/**
* it creates the XML output for VDLGenerator
*
* @param res the result set of the query on database
* @return String the XML
*/
public static List<CollectionType> prepareCollections(ResultSet res, ArrayList<String> relatedCollection){
List<CollectionType> collectionList= new ArrayList<CollectionType>();
try{
while (res.next()){
CollectionType collection= new CollectionType();
collection.setId(res.getString(1));
collection.setName(res.getString(2));
Calendar creationTime = Calendar.getInstance();
creationTime.setTimeInMillis(Long.parseLong(res.getString(5)));
Calendar lastUpdateTime = Calendar.getInstance();
lastUpdateTime.setTimeInMillis(Long.parseLong(res.getString(6)));
collection.setInfo(new CollectionTypeInfo(creationTime, res.getString(3),lastUpdateTime, Integer.parseInt(res.getString(4))));
collection.setSelected(relatedCollection.contains(res.getString(1)));
collectionList.add(collection);
}
}catch(SQLException e){
logger.error("database error "+e.getMessage());
e.printStackTrace();
}
return collectionList;
}
/**
*
* @param res
* @param relatedGHNs
* @param candidateGHN
* @return
*/
public static List<GHNType> prepareGHNs(ResultSet res, ArrayList<String> relatedGHNs, String candidateGHN){
List<GHNType> ghnTypeList= new ArrayList<GHNType>();
try{
ResultSet riRes;
while (res.next()){
//controlling all the RIs on the GHN
riRes= DBInterface.queryDB("select RI.id, RI.name, RI.class from RUNNINGINSTANCE as RI, GHNRELATEDRI as REL where REL.GHNID='"+res.getString("ID")+"' and REL.RIID=RI.ID");
int risNum=0;
List<RunningInstance> riList= new ArrayList<RunningInstance>();
while (riRes.next()){
if (!ServiceContext.getContext().getBaseServiceForGhn().contains(new ServicePair(riRes.getString(2),riRes.getString(3))))
risNum++;
riList.add(new RunningInstance(riRes.getString(3),riRes.getString(2)));
}
GHNType ghn= new GHNType();
ghn.setId(res.getString(1));
ghn.setSelectable(!(risNum>0));
ghn.setSelected(relatedGHNs.contains(res.getString(1)));
ghn.setVreManagerUse(candidateGHN.compareTo(res.getString("ID"))==0);
ghn.setHost(res.getString(2));
ghn.setSecurity(res.getString(3));
ghn.setUpTime(res.getString(4));
ghn.setMemory(new GHNTypeMemory(res.getString(7),res.getString(5),res.getString(6)));
ghn.setSite(new GHNTypeSite(res.getString(9),res.getString(10),res.getString(8)));
ghn.setRelatedRIs(riList.toArray(new RunningInstance[riList.size()]));
ghnTypeList.add(ghn);
}
}catch(SQLException e){
logger.error("exception reised getting data from database",e);
}
return ghnTypeList;
}
private static <T> List<T> getDistinctObjects(Collection<T> list){
List<T> tmpList= new ArrayList<T>();
for (T el: list)
if (!tmpList.contains(el)) tmpList.add(el);
return tmpList;
}
/**
*
* @param res
* @return
*/
public static MetadataFormatResponse prepareMCFormat(Hashtable<ModelerCollection, List<MetadataFormat>> nativeMetadataFormat, Hashtable<ModelerCollection, List<MetadataFormat>> selectedMetadataFormat){
List<MetadataFormat> mdflistMultiple= new ArrayList<MetadataFormat>();
for (List<MetadataFormat> mftmpList: nativeMetadataFormat.values())
mdflistMultiple.addAll(mftmpList);
List<MetadataFormat> totalMDF= getDistinctObjects(mdflistMultiple);
List<MetadataFormatItem> metadataFormatItemList= new ArrayList<MetadataFormatItem>();
List<MetadataFormatCollectionRelation> metadataFormatRelationList= new ArrayList<MetadataFormatCollectionRelation>();
try{
for (MetadataFormat mf: totalMDF)
metadataFormatItemList.add(new MetadataFormatItem( mf.getId(),mf.getLanguage(),mf.getName(),mf.getSchemaURI().toString()));
//setting the native MDF
for(ModelerCollection key: nativeMetadataFormat.keySet()){
MetadataFormatCollectionRelation mfCollectionRelation= new MetadataFormatCollectionRelation();
mfCollectionRelation.setCollId(key.getId());
mfCollectionRelation.setDescription(key.getDescription());
mfCollectionRelation.setName(key.getName());
List<MetadataFormatRelation> mfList= new ArrayList<MetadataFormatRelation>();
for(MetadataFormat mf: nativeMetadataFormat.get(key))
if(selectedMetadataFormat.isEmpty() || ((selectedMetadataFormat.get(key)!=null) && selectedMetadataFormat.get(key).contains(mf)))
mfList.add(new MetadataFormatRelation(mf.getId(),true, true));
else mfList.add(new MetadataFormatRelation(mf.getId(),true, false));
mfCollectionRelation.setMfList(mfList.toArray(new MetadataFormatRelation[mfList.size()]));
metadataFormatRelationList.add(mfCollectionRelation);
}
}catch(Exception e){
logger.warn("error getting metadataFormats",e);
}
return new MetadataFormatResponse(metadataFormatRelationList.toArray(new MetadataFormatCollectionRelation[metadataFormatRelationList.size()]),metadataFormatItemList.toArray(new MetadataFormatItem[metadataFormatItemList.size()]));
}
/**
*
* @return the XML representing the quality string
*/
public static String prepareQualityXML(){
StringBuilder qualityString=new StringBuilder();
qualityString.append("<ResultSet>");
qualityString.append("<Quality><DisplayName>Response Time</DisplayName><Description>This quality parameter indicates the importance of response time (i.e., the delay from a function request to the reception of the response) ");
qualityString.append("in selecting the resource (both in number and type) needed to satisfy the Digital Library definition criteria. E.g., the specification of a 100% response time will result in a maximization of the resources ");
qualityString.append("allocated as to minimise the response time. </Description><Multiple value=\"true\"/><CanBeEmpty value=\"false\"/><AllowedValues><Value default=\"true\" selected=\"false\">*</Value></AllowedValues></Quality>");
qualityString.append("<Quality><DisplayName>Robustness</DisplayName><Description>This quality parameter indicates the importance of robustness (i.e., the resilience to faults) in selecting the resource (both in number and type)");
qualityString.append(" needed to satisfy the Digital Library definition criteria. E.g., the specification of a 100% robustness will result in a maximisation of the resources allocated as to minimise service unavailability.</Description><Multiple ");
qualityString.append(" value=\"true\"/><CanBeEmpty value=\"false\"/><AllowedValues><Value default=\"true\" selected=\"false\">*</Value></AllowedValues></Quality>");
qualityString.append("<Quality><DisplayName>Scalability</DisplayName><Description>This quality parameter indicates the importance of scalability (i.e., the capability to increase Digital Library Capacity as much as needed) in selecting the resource ");
qualityString.append("(both in number and type) needed to satisfy the Digital Library definition criteria. E.g., the specification of a 100% scalability will result in a maximisztion of the resources allocated as to minimise the response time.</Description>");
qualityString.append("<Multiple value=\"true\"/><CanBeEmpty value=\"false\"/><AllowedValues><Value default=\"true\" selected=\"false\">*</Value></AllowedValues></Quality>");
qualityString.append("<Quality><DisplayName>Re-use</DisplayName><Description>This quality parameter indicates the willingness to re-use existing resources (running instances, indexes, etc.) across various Digital Libraries. The specified ");
qualityString.append("percentage represents the degree of re-use of existing assets in concretely implementing the Digital Library.</Description><Multiple value=\"true\"/><CanBeEmpty value=\"false\"/><AllowedValues><Value default=\"true\" selected=\"false\">*</Value></AllowedValues></Quality>");
qualityString.append("<Quality><DisplayName>Capacity</DisplayName><Description>This quality parameter indicates the importance of capacity (i.e., the amount of resources allocated to the Digital Library) in selecting the resource (both in number and type) ");
qualityString.append("needed to satisfy the Digital Library definition criteria. E.g., the specification of a 100% capacity will result in a maximization of the amount of resources allocated to the Digital Library.");
qualityString.append(" </Description><Multiple value=\"true\"/><CanBeEmpty value=\"false\"/><AllowedValues><Value default=\"true\" selected=\"false\">*</Value></AllowedValues></Quality>");
qualityString.append("<Quality><DisplayName>Security</DisplayName><Description>A true/false quality parameter indicates whether the operations have to be executed in a fully authorised and authenticated environment (true value) or ");
qualityString.append("not (false value)</Description><Multiple value=\"false\"/><CanBeEmpty value=\"false\"/><AllowedValues><Value default=\"true\" selected=\"false\">Yes</Value><Value default=\"false\" selected=\"false\">No</Value></AllowedValues></Quality>");
qualityString.append("</ResultSet>");
return qualityString.toString();
}
/**
*
* @param res
* @param selectedFunct
* @param selectedCS
* @return
*/
public static List<FunctionalityItem> prepareFunctionalities(ResultSet res, ArrayList<Integer> selectedFunct, ArrayList<String> selectedCS){
List<FunctionalityItem> functionalityItemList= new ArrayList<FunctionalityItem>();
try {
while(res.next()){
FunctionalityItem functionlityItem= new FunctionalityItem();
functionlityItem.setId(res.getInt(1));
functionlityItem.setName(res.getString(2));
functionlityItem.setSelected(selectedFunct.contains(res.getInt(1)));
functionlityItem.setDescription(res.getString(3));
List<FunctionalityItem> subFunctionalities= new ArrayList<FunctionalityItem>();
ResultSet subFunctRes=DBInterface.queryDB("select * from FUNCTIONALITY where father='"+res.getInt(1)+"';");
while(subFunctRes.next()){
FunctionalityItem subFunctionalityItem= new FunctionalityItem();
subFunctionalityItem.setId(subFunctRes.getInt(1));
subFunctionalityItem.setName(subFunctRes.getString(2));
subFunctionalityItem.setDescription(subFunctRes.getString(3));
subFunctionalityItem.setSelected(selectedFunct.contains(subFunctRes.getInt(1)));
subFunctionalities.add(subFunctionalityItem);
}
functionlityItem.setChilds(subFunctionalities.toArray(new FunctionalityItem[subFunctionalities.size()]));
functionalityItemList.add(functionlityItem);
}
} catch (SQLException e) {
logger.error("DB error preparing Functionalities",e);
}
return functionalityItemList;
}
/**
*
* @param res
* @return a String representing the message
* @throws Exception
*/
public static VREDescription prepareVREDescription(ResultSet res) throws Exception{
VREDescription vreDescription= new VREDescription();
if (res.next()){
vreDescription.setName(res.getString(2));
vreDescription.setDescription(res.getString(3));
vreDescription.setDesigner(res.getString(4));
vreDescription.setManager(res.getString(5));
Calendar calendarStart= Calendar.getInstance();
calendarStart.setTime(res.getDate(6));
vreDescription.setStartTime(calendarStart);
Calendar calendarEnd= Calendar.getInstance();
calendarEnd.setTime(res.getDate(7));
vreDescription.setEndTime(calendarEnd);
}else{
Calendar calendarStart= Calendar.getInstance();
Calendar calendarEnd= Calendar.getInstance();
calendarEnd.add(Calendar.YEAR, 1);
vreDescription.setName(null);
vreDescription.setDescription(null);
vreDescription.setDesigner(null);
vreDescription.setManager(null);
vreDescription.setStartTime(calendarStart);
vreDescription.setEndTime(calendarEnd);
}
return vreDescription;
}
/**
*
* @param res
* @return
* @throws Exception
*/
public static List<Report> prepareVREsList(ResultSet res) throws Exception{
List<Report> reportList= new ArrayList<Report>();
while (res.next()){
Report reportItem= new Report();
reportItem.setId(res.getString(4));
reportItem.setDescription(res.getString(2));
reportItem.setName(res.getString(1));
reportItem.setState(res.getString(3));
reportList.add(reportItem);
}
return reportList;
}
/**
* transform a Document into string
*
* @param doc Document
* @return a String
*/
public static String docToString(Document doc){
String temp= null;
try{
DOMSource domSource = new DOMSource(doc);
TransformerFactory tf = TransformerFactory.newInstance();
Transformer serializer = tf.newTransformer();
serializer.setOutputProperty("encoding", "UTF-8");
serializer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes" );
StringWriter sw= new StringWriter();
StreamResult sr= new StreamResult(sw);
serializer.transform(domSource, sr);
temp=sr.getWriter().toString();
}catch(Exception e){
logger.error("transformation to String Error");
e.printStackTrace();
}
return temp;
}
/**
*
* @param doc the root Document
* @param root the element tag name
* @param elements elements to add
* @return the result element
*/
public static Element addElements(Document doc, String root, Element[] elements){
Element returnEl= doc.createElement(root);
for (Element el: elements){
returnEl.appendChild(el);
}
return returnEl;
}
/**
*
* @param doc the root Document
* @param Tag the element tag name
* @param text the text to add at the element
* @return the result element
*/
public static Element createTextElement(Document doc, String tag, String text, Pair<String, String> ... attributes ){
Element returnEl= doc.createElement(tag);
if (attributes!=null){
for (Pair<String, String> attribute : attributes){
returnEl.setAttribute(attribute.first, attribute.second);
}
}
if (text!=null) returnEl.appendChild(doc.createTextNode(text));
return returnEl;
}
}