Coverage Summary for Class: MetsKitodoObjectFactory (org.kitodo.dataeditor)

 /*
  * (c) Kitodo. Key to digital objects e. V. <contact@kitodo.org>
  *
  * This file is part of the Kitodo project.
  *
  * It is licensed under GNU General Public License version 3 or later.
  *
  * For the full copyright and license information, please read the
  * GPL3-License.txt file that was distributed with this source code.
  */
 
 package org.kitodo.dataeditor;
 
 import java.io.IOException;
 
 import javax.xml.datatype.DatatypeConfigurationException;
 
 import org.kitodo.dataeditor.entities.DmdSec;
 import org.kitodo.dataeditor.entities.FileSec;
 import org.kitodo.dataeditor.entities.LogicalStructMapType;
 import org.kitodo.dataeditor.entities.PhysicalStructMapType;
 import org.kitodo.dataeditor.entities.StructLink;
 import org.kitodo.dataformat.metskitodo.DivType;
 import org.kitodo.dataformat.metskitodo.KitodoType;
 import org.kitodo.dataformat.metskitodo.MdSecType;
 import org.kitodo.dataformat.metskitodo.MetsType;
 import org.kitodo.dataformat.metskitodo.ObjectFactory;
 import org.kitodo.dataformat.metskitodo.StructMapType;
 
 /**
  * This class is extending the jaxb generated object factory for creating
  * mets-kitodo objects by population some objects with application specific
  * values.
  */
 public class MetsKitodoObjectFactory extends ObjectFactory {
 
     /**
      * Creates KitodoType object which version indication of used kitodo format.
      *
      * @return The KitodoType object.
      */
     public KitodoType createKitodoType() {
         KitodoType kitodoType = super.createKitodoType();
         kitodoType.setVersion(VersionProvider.getDataFormatVersion());
         return kitodoType;
     }
 
     /**
      * Creates a kitodo data editor specific MetsHdr.Agent object.
      *
      * @return The MetsHdr.Agent object.
      */
     public MetsType.MetsHdr.Agent createKitodoMetsAgent() throws IOException {
         MetsType.MetsHdr.Agent metsAgent = super.createMetsTypeMetsHdrAgent();
         metsAgent.setOTHERTYPE("SOFTWARE");
         metsAgent.setROLE("CREATOR");
         metsAgent.setTYPE("OTHER");
         metsAgent.setName(VersionProvider.getModuleVersionInfo());
         return metsAgent;
     }
 
     /**
      * Creates a kitodo data editor specific MetsHdr object, which sets CREATEDATE
      * and agent.
      *
      * @return The MetsHdr object.
      */
     public MetsType.MetsHdr createKitodoMetsHeader() throws DatatypeConfigurationException, IOException {
         MetsType.MetsHdr metsTypeMetsHdr = super.createMetsTypeMetsHdr();
         metsTypeMetsHdr.setCREATEDATE(JaxbXmlUtils.getXmlTime());
         MetsType.MetsHdr.Agent metsAgent = createKitodoMetsAgent();
         metsTypeMetsHdr.getAgent().add(metsAgent);
         return metsTypeMetsHdr;
     }
 
     /**
      * Creates a PhysicalStructMapType object.
      *
      * @return The PhysicalStructMapType object.
      */
     public PhysicalStructMapType createPhysicalStructMapType() {
         return new PhysicalStructMapType(createStructMapTypeOfType("PHYSICAL"));
     }
 
     /**
      * Creates a LogicalStructMapType object.
      *
      * @return The LogicalStructMapType object.
      */
     public LogicalStructMapType createLogicalStructMapType() {
         return new LogicalStructMapType(createStructMapTypeOfType("LOGICAL"));
     }
 
     private StructMapType createStructMapTypeOfType(String type) {
         StructMapType structMapType = super.createStructMapType();
         structMapType.setTYPE(type);
         return structMapType;
     }
 
     /**
      * Creates a Mets FileGrp object where the attribute USE is set to LOCAL.
      *
      * @return The FileGrp object.
      */
     public MetsType.FileSec.FileGrp createMetsTypeFileSecFileGrpLocal() {
         MetsType.FileSec.FileGrp metsTypeFileSecFileGrp = super.createMetsTypeFileSecFileGrp();
         metsTypeFileSecFileGrp.setUSE("LOCAL");
         return metsTypeFileSecFileGrp;
     }
 
     /**
      * Creates a DivType object for using as root div in mets physical sruct map.
      *
      * @return The DivType object.
      */
     public DivType createRootDivTypeForPhysicalStructMap() {
         DivType divType = super.createDivType();
         divType.setID("PHYS_ROOT");
         divType.setTYPE("physSequence");
         return divType;
     }
 
     /**
      * Creates a DivType object for using as root div in mets logical sruct map.
      *
      * @return The DivType object.
      */
     public DivType createRootDivTypeForLogicalStructMap(String type, MdSecType dmdSecOfLogicalRootDiv) {
         DivType divType = super.createDivType();
         divType.setID("LOG_ROOT");
         divType.setTYPE(type);
         divType.getDMDID().add(dmdSecOfLogicalRootDiv);
         return divType;
     }
 
     /**
      * Creates a StructLink object.
      * 
      * @return The StructLink object.
      */
     public StructLink createStructLink() {
         return new StructLink(super.createMetsTypeStructLink());
     }
 
     /**
      * Creates a FileSec object.
      * 
      * @return The FileSec object.
      */
     public FileSec createFileSec() {
         return new FileSec(super.createMetsTypeFileSec());
     }
 
     /**
      * Creates a DmdSec object which wraps a KitodoType object.
      *
      * @param kitodoMetadata
      *            The KitodoType object which is holding the metadata.
      * @param id
      *            The id of this DmdSec element.
      * @return The MdSecType object.
      */
     public DmdSec createDmdSecByKitodoMetadata(KitodoType kitodoMetadata, String id) {
         MdSecType mdSec = super.createMdSecType();
         mdSec.setMdWrap(wrapKitodoTypeIntoMdWrap(kitodoMetadata));
         mdSec.setID(id);
         return new DmdSec(mdSec);
     }
 
     /**
      * Created a MdWrap object for kitodo metadata by setting MDTYPE and
      * OTHERMDTYPE.
      *
      * @return The MdWrap object.
      */
     private MdSecType.MdWrap createKitodoMdSecTypeMdWrap() {
         MdSecType.MdWrap mdWrap = super.createMdSecTypeMdWrap();
         mdWrap.setMDTYPE("OTHER");
         mdWrap.setOTHERMDTYPE("KITODO");
         return mdWrap;
     }
 
     private MdSecType.MdWrap wrapKitodoTypeIntoMdWrap(KitodoType kitodoMetadata) {
         MdSecType.MdWrap mdWrap = createKitodoMdSecTypeMdWrap();
         MdSecType.MdWrap.XmlData xmlData = super.createMdSecTypeMdWrapXmlData();
         xmlData.getAny().add(super.createKitodo(kitodoMetadata));
         mdWrap.setXmlData(xmlData);
         return mdWrap;
     }
 }