/**
 * Copyright 2008-2009 DRIVER PROJECT (ICM UW)
 * Original author: Marek Horst
 *
 * 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.
 */
package eu.dnetlib.data.index.dmf;

import java.util.HashMap;
import java.util.Map;

/**
 * DMF document object representation.
 * NOTICE: Current DMFObject implementation is case insensitive.
 * @author Marek Horst
 * @version 0.7.6
 *
 */
public class DMFObject {

//	TODO all fields may contain lang attribute (not used at the moment); DMF document may contain about element
//	TODO add fields validation (maxOccurs)
	
	private Map<String, String[]> fields;
	
	public DMFObject() {
		fields = new HashMap<String, String[]>();
	}

	public void putField(String key, String[] value) {
		this.fields.put(key.toLowerCase(), value);
	}
	
	public String[] get(String key) {
		return this.fields.get(key.toLowerCase());
	}

	/**
	 * Returns DMF object XML representation.
	 * @return DMF object XML representation
	 */
	public String getAsXML() {
		StringBuffer strBuff = new StringBuffer();
		strBuff.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
		strBuff.append("<dmf_record ");
//		FIXME set valid xsi:noNamespaceSchemaLocation
		strBuff.append("xsi:noNamespaceSchemaLocation=\"http://129.70.12.28:8005/config/DMFSchema.xsd\" ");
		strBuff.append("xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" ");
		strBuff.append("xmlns:dr=\"http://www.driver-repository.eu/namespace/dr\" ");
		strBuff.append("xmlns:dc=\"http://purl.org/dc/elements/1.1/\">");
		strBuff.append(getHeaderAsXML());
		strBuff.append(getMetadataAsXML());
		strBuff.append("</dmf_record>");
		return strBuff.toString();
	}
	
	/**
	 * Returns DMF header XML representation.
	 * @return DMF header XML representation
	 */
	private String getHeaderAsXML() {
		StringBuffer strBuff = new StringBuffer();
		strBuff.append("<header>");
		strBuff = appendFieldsAsXML(DMFHeaderFields.DR_objectIdentifier,strBuff);
		strBuff = appendFieldsAsXML(DMFHeaderFields.DR_dateOfCollection,strBuff);
		strBuff = appendFieldsAsXML(DMFHeaderFields.DR_recordIdentifier,strBuff);
		strBuff = appendFieldsAsXML(DMFHeaderFields.DR_itemIdentifier,strBuff);
		strBuff.append("</header>");
		return strBuff.toString();
	}

	/**
	 * Returns DMF metadata XML representation.
	 * @return DMF metadata XML representation
	 */
	private String getMetadataAsXML() {
		StringBuffer strBuff = new StringBuffer();
		strBuff.append("<metadata>");
		strBuff = appendFieldsAsXML(DMFMetadataFields.DR_CobjContentSynthesis,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DR_CobjTypology,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DR_CobjIdentifier,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DR_CobjModel,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DR_CobjMDFormats,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DR_CobjDescriptionSynthesis,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DR_repositoryName,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DR_repositoryLink,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DR_repositoryCountry,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DR_repositoryInstitution,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DC_creator,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DC_title,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DC_subject,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DR_CobjCategory,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DC_language,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DC_dateAccepted,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DC_identifier,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DC_publisher,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DC_source,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DC_contributor,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DC_relation,strBuff);
		strBuff = appendFieldsAsXML(DMFMetadataFields.DC_description,strBuff);
		strBuff.append("</metadata>");
		return strBuff.toString();
	}

	/**
	 * Appends XML fields representation to StringBuffer
	 * @param fieldName
	 * @param workingStrBuff
	 * @return StringBuffer
	 */
	private StringBuffer appendFieldsAsXML(String fieldName, 
			StringBuffer workingStrBuff) {
		if (fieldName==null)
			return workingStrBuff;
		String[] values = this.get(fieldName);
		if (values==null || values.length==0) {
			if (DMFMetadataFields.NILLABLE_FIELDS.contains(fieldName))
				return workingStrBuff;
			else {
				workingStrBuff.append("<"+fieldName+"/>");
				return workingStrBuff;
			}
		} else {
			for (int i = 0; i < values.length; i++) {
				workingStrBuff.append('<' + fieldName + '>');
				workingStrBuff.append(values[i]);
				workingStrBuff.append("</" + fieldName + '>');
			}
			return workingStrBuff;
		}
	}
}