/**
 * <copyright> Copyright 2006 by Know-Center, Graz, Austria </copyright>
 * PDF-AS has been contracted by the E-Government Innovation Center EGIZ, a
 * joint initiative of the Federal Chancellery Austria and Graz University of
 * Technology.
 *
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 * http://www.osor.eu/eupl/
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and
 * limitations under the Licence.
 *
 * This product combines work with different licenses. See the "NOTICE" text
 * file for details on the various modules and licenses.
 * The "NOTICE" text file is part of the distribution. Any derivative works
 * that you distribute must include a readable copy of the "NOTICE" text file.
 */
package at.gv.egiz.pdfas.impl.api.commons;

import java.util.Properties;

import org.apache.commons.lang.builder.ToStringBuilder;

import at.gv.egiz.pdfas.api.commons.SignatureProfile;

/**
 * Holds the data of a signature profile.
 * 
 * @author wprinz
 */
public class SignatureProfileImpl implements SignatureProfile {

   /**
    * The profile identifier.
    */
   protected String profileId = null;

   /**
    * The MOA key identifiert of this profile.
    */
   protected String moaKeyIdentifier = null;

   /**
    * Properties containing the layout settings relevant to the search algorithm
    * for signature blocks.
    */
   protected Properties signatureBlockEntries;
   
   /**
    * Short description of the profile.
    */
   protected String profileDescription;
   
   /**
    * true if this is the default profile, false otherwise.
    */
   protected boolean defaultProfile = false;

   /**
    * Constructor.
    * 
    * @param profileId
    *           The profile identifier.
    * @param moaKeyIdentifier
    *           The MOA key identifier of this profile.
    */
   public SignatureProfileImpl(String profileId, String moaKeyIdentifier) {
      this.profileId = profileId;
      this.moaKeyIdentifier = moaKeyIdentifier;
      this.signatureBlockEntries = new Properties();
   }
   
   /**
    * Constructor.
    * 
    * @param profileId
    *           The profile identifier.
    * @param profileDescription
    *           The profile description.
    * @param moaKeyIdentifier
    *           The MOA key identifier of this profile.
    * @param isDefault 
    */
   public SignatureProfileImpl(String profileId, String profileDescription, String moaKeyIdentifier, boolean isDefault) {
      this.profileId = profileId;
      this.moaKeyIdentifier = moaKeyIdentifier;
      this.profileDescription = profileDescription;
      this.signatureBlockEntries = new Properties();
      this.defaultProfile = isDefault;
   }

   /**
    * @see at.gv.egiz.pdfas.api.commons.SignatureProfile#getProfileId()
    */
   public String getProfileId() {
      return this.profileId;
   }

   /**
    * @see at.gv.egiz.pdfas.api.commons.SignatureProfile#getMOAKeyIdentifier()
    */
   public String getMOAKeyIdentifier() {
      return this.moaKeyIdentifier;
   }

   /**
    * @see at.gv.egiz.pdfas.api.commons.SignatureProfile#getSignatureBlockEntries()
    */
   public Properties getSignatureBlockEntries() {
      return this.signatureBlockEntries;
   }

   /**
    * Sets the entries relevant to the search algorithm for signature blocks.<br/>
    * e.g. properties starting with <code>sig_obj.PROFILE.key.</code> and
    * properties of the form <code>sig_obj.PROFILE.table.TABLENAME.NUMBER</code>
    * where <code>PROFILE</code> is the name of the current profile,
    * <code>TABLENAME</code> is the name of a table and <code>NUMBER</code>
    * is the number of the specific row within the table <code>TABLENAME</code>.
    * 
    * @param signatureBlockEntries
    *           The entries relevant to the signature block search algorithm as
    *           Java properties.
    */
   public void setSignatureBlockEntries(Properties signatureBlockEntries) {
      this.signatureBlockEntries = signatureBlockEntries;
   }
   
   /**
    * Returns the profile description.
    * @return The profile description.
    */
   public String getProfileDescription() {
      return this.profileDescription;
   }

   public String toString() {
      return new ToStringBuilder(this)
         .append("profileId", this.profileId)
         .append("profileDescription", this.profileDescription)
         .append("moaKeyIdentifier", this.moaKeyIdentifier)
         .toString();
   }

   /**
    * 
    */
   public boolean isDefault() {
      return this.defaultProfile;
   }

}