MetadataInstance.java

/*
   Copyright (C) 2005-2012, by the President and Fellows of Harvard College.

   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.

   Dataverse Network - A web application to share, preserve and analyze research data.
   Developed at the Institute for Quantitative Social Science, Harvard University.
   Version 3.0.
*/
package edu.harvard.iq.dvn.api.entities;

import java.io.File;
import java.io.ByteArrayOutputStream;
import java.io.UnsupportedEncodingException; 

import edu.harvard.iq.dvn.core.study.Study;
import edu.harvard.iq.dvn.core.study.StudyExporter;
import edu.harvard.iq.dvn.core.util.FileUtil;

/**
 *
 * @author leonidandreev
 */
public class MetadataInstance {

    private String globalStudyId; 
    private Long studyId;
    private Study study; 

    private String formatType; 
    
    private String parameterIncludeSection; 
    private String parameterExcludeSection; 

    private Boolean isAvailable = false; 
    private Boolean isAccessAuthorized = true; 
    private Boolean isCached = false; 
    private Boolean isByteArray = false; 
    
    private File cachedMetadataFile; 
    private byte[] generatedMetadataBytes; 
    
    public MetadataInstance() {
        this.formatType = "ddi";
    }
    
    
    public MetadataInstance(String globalId) {
        this(globalId, "ddi", null, null);
    }
    
    public MetadataInstance(String globalId, String format, String partialExclude, String partialInclude) {
        globalStudyId = globalId;
        formatType = format; 
        parameterIncludeSection = partialInclude; 
        parameterExcludeSection = partialExclude; 
        
        //lookupMetadataFile(); 
        
    }
    
    public MetadataInstance(Long localId) {
        this(localId, "ddi", null, null);
    }

    public MetadataInstance(Long localId, String format, String partialExclude, String partialInclude) {
        studyId = localId;
        formatType = format;
        parameterIncludeSection = partialInclude; 
        parameterExcludeSection = partialExclude; 
       
        //lookupMetadataFile(); 
    }
     
    public Long getStudyId() {
        return studyId;
    }
    
    public void setStudyId(Long localId) {
        studyId = localId; 
    }
    
    public String getGlobalStudtId() {
        return globalStudyId; 
    }
    
    public void setGlobalStudyId(String globalId) {
        globalStudyId = globalId; 
    }
    
    public Study getStudy () {
        return this.study; 
    }
    
    public void setStudy(Study s) {
        this.study = s; 
    }
    
    public Boolean isAvailable() {
        return isAvailable; 
    }
    
    public void setAvailability(Boolean availability) {
        isAvailable = availability; 
    }
    
    public Boolean isAccessAuthorized() {
        return isAccessAuthorized; 
    }
    
    public void setAccessAuthorized(Boolean authorized) {
        isAccessAuthorized = authorized; 
    }
    
    public Boolean isCached() {
        return isCached; 
    }
    
    public Boolean isByteArray() {
        return isByteArray; 
    }
    
    public File getCachedMetadataFile () {
        return cachedMetadataFile; 
    }
    
    public byte[] getByteArray() {
        return generatedMetadataBytes; 
    }
    
    public void lookupMetadata(StudyExporter studyExporter) {
        lookupMetadataFile(studyExporter);
    }
    
    public void lookupMetadata() {
        lookupMetadataFile(null); 
        
        // If this is a request for a partial record, if it's not cached, 
        // we'll attempt to generate it in real time: 
        
        /*
        if (!this.isAvailable) {
            if ((parameterExcludeSection != null && !(parameterExcludeSection.equals("")))
                ||
                (parameterIncludeSection != null && !(parameterIncludeSection.equals("")))) { 
                generatePartialInstance(); 
            }   
        }
         * 
         */
        
    }
    
    private void generatePartialInstance() {
        
    }
    
    private void lookupMetadataFile(StudyExporter studyExporter) {
        String cachedFileName = null; 
        
        if (this.formatType == null) {
            this.formatType = "ddi";
        }
        
        
        if ((parameterExcludeSection != null && !(parameterExcludeSection.equals("")))
            ||
            (parameterIncludeSection != null && !(parameterIncludeSection.equals("")))) {
            
            if (studyExporter == null) {
                return; 
            }
                    
            ByteArrayOutputStream outStream = null;
            try {
                outStream = new ByteArrayOutputStream();

                studyExporter.exportStudy(
                        study, 
                        outStream, 
                        parameterExcludeSection, 
                        parameterIncludeSection);
            } catch (Exception e) {
                // For whatever reason we've failed to generate a partial 
                // metadata record requested. We simply return - which will
                // result in having in this metadata instance object being
                // tagged as unavailable. 
                return; 
            }
            
            this.isAvailable = true;
            this.isAccessAuthorized = true; 
            this.isByteArray = true; 
            this.generatedMetadataBytes = outStream.toByteArray(); 
            
            
            return; 
        }
        
        if (globalStudyId != null) {
            int index1 = globalStudyId.indexOf(':');
            int index2 = globalStudyId.indexOf('/');
            String idAuthority = globalStudyId.substring(index1 + 1, index2);
            String idToken = globalStudyId.substring(index2 + 1).toUpperCase();

            File studyFileDir = FileUtil.getStudyFileDir(idAuthority, idToken);

        
            if (studyFileDir != null && studyFileDir.exists()) {
                cachedFileName = studyFileDir.getAbsolutePath() + File.separator + "export_" + formatType +".xml";
            }
            
            File lookupFile = new File (cachedFileName);
            
            if (lookupFile.exists()) {
                this.isAvailable = true;
                this.isAccessAuthorized = true; 
                this.isCached = true; 
                this.cachedMetadataFile = lookupFile; 
            }
        }
        
    }
    
    @Override
    public String toString() {
        if (generatedMetadataBytes != null) {
            try {
                return new String(generatedMetadataBytes, "UTF-8"); 
            } catch (UnsupportedEncodingException ex) {
                return null; 
            }
        }
        
        return null; 
    }
}