/*
    * Copyright 2007 The International Moth Class Association (IMCA)
    *
    * 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 net.sf.imca.model.entities;
  
  import java.util.Collection;
  import java.util.Locale;
  
  import javax.persistence.Entity;
  import javax.persistence.GeneratedValue;
  import javax.persistence.GenerationType;
  import javax.persistence.Id;
  import javax.persistence.NamedQuery;
  import javax.persistence.NamedQueries;
  import javax.persistence.OneToMany;
  import javax.persistence.ManyToMany;
  
  /**
   * An persistence entity description. There is no logic just getter and setters,
   * for the properties. This Object represents a table in the database and the
   * properties are fields.
   *
   * @author dougculnane
   */
  @Entity
  @NamedQueries( {
          @NamedQuery(name = "findAssociationByCountryCode",
                  query = "SELECT a FROM AssociationEntity a WHERE " +
                  		"a.isoCountryCode= :isoCountryCode"),
          @NamedQuery(name = "findAssociationByCountryCodeAndArea", 
                  query = "SELECT a FROM AssociationEntity a WHERE " +
                  		"a.isoCountryCode= :isoCountryCode AND a.area = :area"),
  		@NamedQuery(name = "findAllAssociations", 
                  query = "SELECT a FROM AssociationEntity a " +
                  		"ORDER BY a.isoCountryCode"),
         @NamedQuery(name = "findAssociationsWithWebsites", 
                  query = "SELECT a FROM AssociationEntity a " +
                          "WHERE a.url != '' ORDER BY a.isoCountryCode"), 
          @NamedQuery(name = "findAssociationByIsOfficial", 
                  query = "SELECT a FROM AssociationEntity a " +
                          "WHERE a.isOfficiallyImca = :isOfficial"),
          @NamedQuery(name = "AssociationBasicSearch",
                  query = "SELECT a FROM AssociationEntity a WHERE " +
                  		"a.isoCountryCode LIKE :search OR a.area LIKE :search")
  })
  public class AssociationEntity {
  
      /**
       * Object Identifier.
       */
      @Id
      @GeneratedValue(strategy=GenerationType.TABLE)
      private long id;
  
      /**
       * Is the association recognized as an Official IMCA association.
       */
      private boolean isOfficiallyImca = false;
  
      /**
       * Website of association.
       */
      private String url = "";
  
      /**
       * Bank or other payment information so that members can pay fees to the 
       * association.
       */
      private String paymentExplanation = "Contact Secretary for info.";
  
      /**
       * Collection of members.
       */
      @ManyToMany
      private Collection<MembershipEntity> members;
  
      /**
       * Collection of committee members.
       */
      @OneToMany
      private Collection<CommitteeMemberEntity> committee;
  
      /**
       * Indication of area when the country is split into area association.
       */
      private String area = "";
  
     /**
      * 2 digit ISO Country code for association.
      */
     private String isoCountryCode = "";
 
     public String getIsoCountryCode() {
         return isoCountryCode;
     }
 
     public void setIsoContryCode(String isoCountryCode) {
         this.isoCountryCode = isoCountryCode;
     }
 
     public boolean getIsOfficiallyImca() {
         return isOfficiallyImca;
     }
 
     public void setIsOfficiallyImca(boolean isOfficiallyImca) {
         this.isOfficiallyImca = isOfficiallyImca;
     }
 
     public String getPaymentExplanation() {
         return paymentExplanation;
     }
 
     public void setPaymentExplanation(String paymentExplanation) {
         this.paymentExplanation = paymentExplanation;
     }
 
     public Collection<CommitteeMemberEntity> getCommittee() {
         return committee;
     }
 
     public void setCommittee(Collection<CommitteeMemberEntity> committee) {
         this.committee = committee;
     }
 
     public void setIsoCountryCode(String isoCountryCode) {
         this.isoCountryCode = isoCountryCode;
     }
 
     public String getArea() {
         return area;
     }
 
     public void setArea(String area) {
         this.area = area;
     }
 
     public long getId() {
         return id;
     }
 
     public void setId(long id) {
         this.id = id;
     }
 
     public Collection<MembershipEntity> getMembers() {
         return members;
     }
 
     public void setMembers(Collection<MembershipEntity> members) {
         this.members = members;
     }
 
     public String getUrl() {
         return url;
     }
 
     public void setUrl(String url) {
         this.url = url;
     }
 
     /**
      * Override the Object method to give a usable human readable 
      * representation of the Object.
      */
     public String toString() {
         StringBuffer buf = new StringBuffer();
         buf.append("International Moth ");
         
         if (this.isOfficiallyImca) {
             buf.append("Class Association");
         } else  {
             buf.append("Fleet");
         }
         if (!"".equals(isoCountryCode)){
             buf.append(" ( ");
             if (!"".equals(area)){
                 buf.append(area);
                 buf.append(", ");
             }
             Locale loc = new Locale("", isoCountryCode);
             buf.append(loc.getISO3Country().toUpperCase(Locale.ENGLISH));
             buf.append(" ).");
         }
         return buf.toString();
     }
 
 }