gov.loc.repository.bagit.impl.BagInfoTxtImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bagit Show documentation
The BAGIT LIBRARY is a software library intended to support the creation, manipulation, and validation of bags. Its current version is 0.97. It is version aware with the earliest supported version being 0.93.
There is a newer version: 5.2.0
Show newest version
package gov.loc.repository.bagit.impl;

import java.lang.reflect.Field;
import java.text.DateFormat;
import java.text.MessageFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.List;

import gov.loc.repository.bagit.Bag.BagConstants;
import gov.loc.repository.bagit.Bag;
import gov.loc.repository.bagit.BagFile;
import gov.loc.repository.bagit.BagHelper;
import gov.loc.repository.bagit.BagInfoTxt;
import gov.loc.repository.bagit.utilities.namevalue.NameValueReader.NameValue;
import gov.loc.repository.bagit.utilities.namevalue.impl.AbstractNameValueMapListBagFile;

public class BagInfoTxtImpl extends AbstractNameValueMapListBagFile implements BagInfoTxt {

	public static final String FIELD_SOURCE_ORGANIZATION = "Source-Organization";
	public static final String FIELD_ORGANIZATION_ADDRESS = "Organization-Address";
	public static final String FIELD_CONTACT_NAME = "Contact-Name";
	public static final String FIELD_CONTACT_PHONE = "Contact-Phone";
	public static final String FIELD_CONTACT_EMAIL = "Contact-Email";
	public static final String FIELD_EXTERNAL_DESCRIPTION = "External-Description";
	public static final String FIELD_BAGGING_DATE = "Bagging-Date";
	public static final String FIELD_EXTERNAL_IDENTIFIER = "External-Identifier";
	public static final String FIELD_BAG_SIZE = "Bag-Size";
	public static final String FIELD_PAYLOAD_OXUM = "Payload-Oxum";
	public static final String FIELD_BAG_GROUP_IDENTIFIER = "Bag-Group-Identifier";
	public static final String FIELD_BAG_COUNT = "Bag-Count";
	public static final String FIELD_INTERNAL_SENDER_IDENTIFIER = "Internal-Sender-Identifier";
	public static final String FIELD_INTERNAL_SENDER_DESCRIPTION = "Internal-Sender-Description";
	private static final String STREAM_COUNT_PART = "Stream Count";
	private static final String OCTET_COUNT_PART = "Octet Count";
	
	
	private static final long serialVersionUID = 1L;
	private DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
	
	public BagInfoTxtImpl(BagFile bagFile, BagConstants bagConstants) {
		super(bagConstants.getBagInfoTxt(), bagFile, bagConstants.getBagEncoding());
	}
	
	public BagInfoTxtImpl(BagConstants bagConstants) {
		super(bagConstants.getBagInfoTxt(), bagConstants.getBagEncoding());
			
	}

	@Override
	public String getBagCount() {
		return this.getCaseInsensitive(FIELD_BAG_COUNT);
	}

	@Override
	public Integer getTotalBagsInGroup() throws ParseException {
		String bagCount = this.getBagCount(); 
		if (bagCount == null) {
			return null;
		}
		int pos = bagCount.indexOf(" of ");
		if (pos == -1 || pos+4 >= bagCount.length()) {
			throw new ParseException("Bag-Count not structured N of T",0);
		}
		String totalBags = bagCount.substring(pos+4);		
		if ("?".equals(totalBags)) {
			return UNKNOWN_TOTAL_BAGS_IN_GROUP;
		}
		try {
			return Integer.parseInt(totalBags);
		} catch(NumberFormatException ex) {
			throw new ParseException("Total Bags in Group is not an integer: " + totalBags, 0);
		}
	}
	
	@Override
	public Integer getBagInGroup() throws ParseException {
		String bagCount = this.getBagCount(); 
		if (bagCount == null) {
			return null;
		}
		int pos = bagCount.indexOf(" of ");
		if (pos == -1 || pos-1 < 0) {
			throw new ParseException("Bag-Count not structured N of T",0);
		}
		
		String bagInGroup = bagCount.substring(0, pos);
		try {
			return Integer.parseInt(bagInGroup);
		} catch (NumberFormatException ex) {
			throw new ParseException("Bag in Group is not an integer: " + bagInGroup, 0);
		}
	}
	
	@Override
	public String getBagGroupIdentifier() {
		return this.getCaseInsensitive(FIELD_BAG_GROUP_IDENTIFIER);
	}

	@Override
	public String getBagSize() {
		return this.getCaseInsensitive(FIELD_BAG_SIZE);
	}

	@Override
	public void generateBagSize(Bag bag) {
		this.setBagSize(BagHelper.generateBagSize(bag));		
	}
	
	@Override
	public String getBaggingDate() {
		return this.getCaseInsensitive(FIELD_BAGGING_DATE);
	}

	@Override
	public Date getBaggingDateObj() throws ParseException {
		String baggingDate = this.getBaggingDate();
		if (baggingDate == null) {
			return null;
		}
		return this.dateFormat.parse(baggingDate);
	}
	
	@Override
	public String getContactEmail() {
		return this.getCaseInsensitive(FIELD_CONTACT_EMAIL);
	}

	@Override
	public String getContactName() {
		return this.getCaseInsensitive(FIELD_CONTACT_NAME);
	}

	@Override
	public String getContactPhone() {
		return this.getCaseInsensitive(FIELD_CONTACT_PHONE);
	}

	@Override
	public String getExternalDescription() {
		return this.getCaseInsensitive(FIELD_EXTERNAL_DESCRIPTION);
	}

	@Override
	public String getExternalIdentifier() {
		return this.getCaseInsensitive(FIELD_EXTERNAL_IDENTIFIER);
	}

	@Override
	public String getInternalSenderDescription() {
		return this.getCaseInsensitive(FIELD_INTERNAL_SENDER_DESCRIPTION);
	}

	@Override
	public String getInternalSenderIdentifier() {
		return this.getCaseInsensitive(FIELD_INTERNAL_SENDER_IDENTIFIER);
	}

	@Override
	public String getOrganizationAddress() {
		return this.getCaseInsensitive(FIELD_ORGANIZATION_ADDRESS);
	}

	@Override
	public String getPayloadOxum() {
		return this.getCaseInsensitive(FIELD_PAYLOAD_OXUM);
	}

	@Override
	public Long getOctetCount() throws ParseException {
		return this.getOxumPart(OCTET_COUNT_PART);
	}
	
	@Override
	public Long getStreamCount() throws ParseException {
		return this.getOxumPart(STREAM_COUNT_PART);
	}
	
	private Long getOxumPart(String part) throws ParseException {
		String oxum = this.getPayloadOxum();
		if (oxum == null) {
			return null;
		}
		String[] split = oxum.split("\\.");
		if (split.length != 2) {
			throw new ParseException("Payload-Oxum is not OctetCount.StreamCount",0);
		}
		
		int pos = 0;
		if (STREAM_COUNT_PART.equals(part)) {
			pos = 1;
		}
		try {	
			return Long.parseLong(split[pos]);
		} catch (NumberFormatException ex) {
			throw new ParseException(part + " is not an integer: " + split[pos], 0);
		}
		
	}
	
	@Override
	public String getSourceOrganization() {
		return this.getCaseInsensitive(FIELD_SOURCE_ORGANIZATION);
	}

	@Override
	public void setBagCount(String bagCount) {
		this.put(FIELD_BAG_COUNT, bagCount);		
	}

	@Override
	public void setBagCount(int bagInGroup, int totalBagsInGroup) {
		String totalBags = Integer.toString(totalBagsInGroup);
		if (totalBagsInGroup == UNKNOWN_TOTAL_BAGS_IN_GROUP) {
			totalBags = UNKNOWN_TOTAL_BAGS_IN_GROUP_MARKER;
		}
		this.setBagCount(MessageFormat.format("{0} of {1}", Integer.toString(bagInGroup), totalBags));
		
	}
	
	@Override
	public void setBagGroupIdentifier(String bagGroupIdentifier) {
		this.put(FIELD_BAG_GROUP_IDENTIFIER, bagGroupIdentifier);
		
	}

	@Override
	public void setBagSize(String bagSize) {
		this.put(FIELD_BAG_SIZE, bagSize);
		
	}

	@Override
	public void setBaggingDate(String baggingDate) {
		this.put(FIELD_BAGGING_DATE, baggingDate);		
	}

	@Override
	public void setBaggingDate(Date date) {
		String dateString = null;
		if (date != null) {
			dateString = this.dateFormat.format(date);
		}
		this.setBaggingDate(dateString);
	}
	
	@Override
	public void setBaggingDate(int year, int month, int day) {
		try {
			this.setBaggingDate(this.dateFormat.parse(MessageFormat.format("{0}-{1}-{2}", Integer.toString(year), month, day)));
			
		} catch (Exception ex) {
			throw new RuntimeException(ex);
		}		
	}
	
	@Override
	public void setContactEmail(String contactEmail) {
		this.put(FIELD_CONTACT_EMAIL, contactEmail);
		
	}

	@Override
	public void setContactName(String contactName) {
		this.put(FIELD_CONTACT_NAME, contactName);
		
	}

	@Override
	public void setContactPhone(String contactPhone) {
		this.put(FIELD_CONTACT_PHONE, contactPhone);
		
	}

	@Override
	public void setExternalDescription(String externalDescription) {
		this.put(FIELD_EXTERNAL_DESCRIPTION, externalDescription);
		
	}

	@Override
	public void setExternalIdentifier(String externalIdentifier) {
		this.put(FIELD_EXTERNAL_IDENTIFIER, externalIdentifier);
		
	}

	@Override
	public void setInternalSenderDescription(String internalSenderDescription) {
		this.put(FIELD_INTERNAL_SENDER_DESCRIPTION, internalSenderDescription);
		
	}

	@Override
	public void setInternalSenderIdentifier(String internalSenderIdentifier) {
		this.put(FIELD_INTERNAL_SENDER_IDENTIFIER, internalSenderIdentifier);
		
	}

	@Override
	public void setOrganizationAddress(String organizationAddress) {
		this.put(FIELD_ORGANIZATION_ADDRESS, organizationAddress);		
	}

	@Override
	public void setPayloadOxum(String payloadOxsum) {
		this.put(FIELD_PAYLOAD_OXUM, payloadOxsum);		
	}
	
	@Override
	public void setPayloadOxum(long octetCount, long streamCount) {
		this.setPayloadOxum(Long.toString(octetCount) + "." + Long.toString(streamCount));
		
	}

	@Override
	public void generatePayloadOxum(Bag bag) {
		this.setPayloadOxum(BagHelper.generatePayloadOctetCount(bag), bag.getPayload().size());		
	}
	
	@Override
	public void setSourceOrganization(String sourceOrganization) {
		this.put(FIELD_SOURCE_ORGANIZATION, sourceOrganization);		
	}
	
	@Override
	public String getType() {
		return BagInfoTxt.TYPE;
	}
	
	public boolean containsKeyCaseInsensitive(String key) {
		if (this.getCaseInsensitive(key) != null) {
			return true;
		}
		return false;
	}
	
	private Collection getActualKeys(String key) {
		List actualKeys = new ArrayList();
		for(String name : this.keySet()) {
			if (name.equalsIgnoreCase(key)) {
				actualKeys.add(name);
			}
		}
		return actualKeys;		
	}
	
	public String getCaseInsensitive(String key) {
		if (key == null) {
			return this.get(key);
		}
		for(String name : this.keySet()) {
			if (key.equalsIgnoreCase(name)) {
				return this.get(name);
			}
		}
		return null;
	}
	
	@Override
	public List getListCaseInsensitive(String key) {
		List values = new ArrayList();
		for(NameValue nameValue : this.nameValueList) {
			if (nameValue.getName().equalsIgnoreCase(key)) values.add(nameValue.getValue());
		}
		return values;

	}
	
	@Override
	public List getStandardFields() {
		List standardFields = new ArrayList();
		Field[] fields = this.getClass().getFields();
		try {
			for(Field field : fields) {
				if (field.getName().startsWith("FIELD_") && this.containsKeyCaseInsensitive((String)field.get(this))) {
					standardFields.addAll(this.getActualKeys((String)field.get(this)));
				}
			}			
		}
		catch(Exception ex) {
			throw new RuntimeException(ex);
		}
		return standardFields;
	}
	
	@Override
	public List getNonstandardFields() {
		List standardFields = this.getStandardFields();
		List nonstandardFields = new ArrayList();
		for(String key : this.keySet()) {
			if (! standardFields.contains(key)) {
				nonstandardFields.add(key);
			}
		}		
		return nonstandardFields;
	}
	
}