/**
   * Create the ValueObject collection to hold the set of DomainObjects.
   *
   * @param map - maps DomainObjects to created ValueObjects
   * @param domainObjectSet - Set of ims.coe.assessment.domain.objects.CommunicationHearing objects.
   */
  public static ims.coe.vo.CommunicationHearingVoCollection
      createCommunicationHearingVoCollectionFromCommunicationHearing(
          DomainObjectMap map, java.util.Set domainObjectSet) {
    ims.coe.vo.CommunicationHearingVoCollection voList =
        new ims.coe.vo.CommunicationHearingVoCollection();
    if (null == domainObjectSet) {
      return voList;
    }
    int rieCount = 0;
    int activeCount = 0;
    java.util.Iterator iterator = domainObjectSet.iterator();
    while (iterator.hasNext()) {
      ims.coe.assessment.domain.objects.CommunicationHearing domainObject =
          (ims.coe.assessment.domain.objects.CommunicationHearing) iterator.next();
      ims.coe.vo.CommunicationHearingVo vo = create(map, domainObject);

      if (vo != null) voList.add(vo);

      if (domainObject != null) {
        if (domainObject.getIsRIE() != null && domainObject.getIsRIE().booleanValue() == true)
          rieCount++;
        else activeCount++;
      }
    }
    voList.setRieCount(rieCount);
    voList.setActiveCount(activeCount);
    return voList;
  }
  /**
   * Create the ValueObject collection to hold the list of DomainObjects.
   *
   * @param map - maps DomainObjects to created ValueObjects
   * @param domainObjectList - List of ims.coe.assessment.domain.objects.CommunicationHearing
   *     objects.
   */
  public static ims.coe.vo.CommunicationHearingVoCollection
      createCommunicationHearingVoCollectionFromCommunicationHearing(
          DomainObjectMap map, java.util.List domainObjectList) {
    ims.coe.vo.CommunicationHearingVoCollection voList =
        new ims.coe.vo.CommunicationHearingVoCollection();
    if (null == domainObjectList) {
      return voList;
    }
    int rieCount = 0;
    int activeCount = 0;
    for (int i = 0; i < domainObjectList.size(); i++) {
      ims.coe.assessment.domain.objects.CommunicationHearing domainObject =
          (ims.coe.assessment.domain.objects.CommunicationHearing) domainObjectList.get(i);
      ims.coe.vo.CommunicationHearingVo vo = create(map, domainObject);

      if (vo != null) voList.add(vo);

      if (domainObject != null) {
        if (domainObject.getIsRIE() != null && domainObject.getIsRIE().booleanValue() == true)
          rieCount++;
        else activeCount++;
      }
    }

    voList.setRieCount(rieCount);
    voList.setActiveCount(activeCount);
    return voList;
  }
  /**
   * Create the ValueObject from the ims.coe.assessment.domain.objects.CommunicationHearing object.
   *
   * @param map DomainObjectMap of DomainObjects to already created ValueObjects.
   * @param domainObject
   */
  public static ims.coe.vo.CommunicationHearingVo create(
      DomainObjectMap map, ims.coe.assessment.domain.objects.CommunicationHearing domainObject) {
    if (null == domainObject) {
      return null;
    }
    // check if the domainObject already has a valueObject created for it
    ims.coe.vo.CommunicationHearingVo valueObject =
        (ims.coe.vo.CommunicationHearingVo)
            map.getValueObject(domainObject, ims.coe.vo.CommunicationHearingVo.class);
    if (null == valueObject) {
      valueObject =
          new ims.coe.vo.CommunicationHearingVo(domainObject.getId(), domainObject.getVersion());
      map.addValueObject(domainObject, valueObject);

      valueObject = insert(map, valueObject, domainObject);
    }
    return valueObject;
  }
  public static ims.coe.assessment.domain.objects.CommunicationHearing extractCommunicationHearing(
      ims.domain.ILightweightDomainFactory domainFactory,
      ims.coe.vo.CommunicationHearingVo valueObject,
      HashMap domMap) {
    if (null == valueObject) {
      return null;
    }
    Integer id = valueObject.getID_CommunicationHearing();
    ims.coe.assessment.domain.objects.CommunicationHearing domainObject = null;
    if (null == id) {
      if (domMap.get(valueObject) != null) {
        return (ims.coe.assessment.domain.objects.CommunicationHearing) domMap.get(valueObject);
      }
      // ims.coe.vo.CommunicationHearingVo ID_CommunicationHearing field is unknown
      domainObject = new ims.coe.assessment.domain.objects.CommunicationHearing();
      domMap.put(valueObject, domainObject);
    } else {
      String key =
          (valueObject.getClass().getName() + "__" + valueObject.getID_CommunicationHearing());
      if (domMap.get(key) != null) {
        return (ims.coe.assessment.domain.objects.CommunicationHearing) domMap.get(key);
      }
      domainObject =
          (ims.coe.assessment.domain.objects.CommunicationHearing)
              domainFactory.getDomainObject(
                  ims.coe.assessment.domain.objects.CommunicationHearing.class, id);

      // TODO: Not sure how this should be handled. Effectively it must be a staleobject exception,
      // but maybe should be handled as that further up.
      if (domainObject == null) return null;

      domMap.put(key, domainObject);
    }
    domainObject.setVersion(valueObject.getVersion_CommunicationHearing());

    // create LookupInstance from vo LookupType
    ims.domain.lookups.LookupInstance value1 = null;
    if (null != valueObject.getHearingImpairment()) {
      value1 = domainFactory.getLookupInstance(valueObject.getHearingImpairment().getID());
    }
    domainObject.setHearingImpairment(value1);
    // create LookupInstance from vo LookupType
    ims.domain.lookups.LookupInstance value2 = null;
    if (null != valueObject.getEffectedEars()) {
      value2 = domainFactory.getLookupInstance(valueObject.getEffectedEars().getID());
    }
    domainObject.setEffectedEars(value2);
    // create LookupInstance from vo LookupType
    ims.domain.lookups.LookupInstance value3 = null;
    if (null != valueObject.getHearingAid()) {
      value3 = domainFactory.getLookupInstance(valueObject.getHearingAid().getID());
    }
    domainObject.setHearingAid(value3);
    // create LookupInstance from vo LookupType
    ims.domain.lookups.LookupInstance value4 = null;
    if (null != valueObject.getHearingAidWithPatientOnAdmission()) {
      value4 =
          domainFactory.getLookupInstance(
              valueObject.getHearingAidWithPatientOnAdmission().getID());
    }
    domainObject.setHearingAidWithPatientOnAdmission(value4);
    // create LookupInstance from vo LookupType
    ims.domain.lookups.LookupInstance value5 = null;
    if (null != valueObject.getBatteriesInOrder()) {
      value5 = domainFactory.getLookupInstance(valueObject.getBatteriesInOrder().getID());
    }
    domainObject.setBatteriesInOrder(value5);
    domainObject.setYearLastHearingTest(valueObject.getYearLastHearingTest());

    return domainObject;
  }
  /**
   * Update the ValueObject with the Domain Object.
   *
   * @param map DomainObjectMap of DomainObjects to already created ValueObjects.
   * @param valueObject to be updated
   * @param domainObject ims.coe.assessment.domain.objects.CommunicationHearing
   */
  public static ims.coe.vo.CommunicationHearingVo insert(
      DomainObjectMap map,
      ims.coe.vo.CommunicationHearingVo valueObject,
      ims.coe.assessment.domain.objects.CommunicationHearing domainObject) {
    if (null == domainObject) {
      return valueObject;
    }
    if (null == map) {
      map = new DomainObjectMap();
    }

    valueObject.setID_CommunicationHearing(domainObject.getId());
    valueObject.setIsRIE(domainObject.getIsRIE());

    // If this is a recordedInError record, and the domainObject
    // value isIncludeRecord has not been set, then we return null and
    // not the value object
    if (valueObject.getIsRIE() != null
        && valueObject.getIsRIE().booleanValue() == true
        && !domainObject.isIncludeRecord()) return null;

    // If this is not a recordedInError record, and the domainObject
    // value isIncludeRecord has been set, then we return null and
    // not the value object
    if ((valueObject.getIsRIE() == null || valueObject.getIsRIE().booleanValue() == false)
        && domainObject.isIncludeRecord()) return null;

    // HearingImpairment
    ims.domain.lookups.LookupInstance instance1 = domainObject.getHearingImpairment();
    if (null != instance1) {
      ims.framework.utils.ImagePath img = null;
      ims.framework.utils.Color color = null;
      img = null;
      if (instance1.getImage() != null) {
        img =
            new ims.framework.utils.ImagePath(
                instance1.getImage().getImageId(), instance1.getImage().getImagePath());
      }
      color = instance1.getColor();
      if (color != null) color.getValue();

      ims.core.vo.lookups.YesNoUnknown voLookup1 =
          new ims.core.vo.lookups.YesNoUnknown(
              instance1.getId(), instance1.getText(), instance1.isActive(), null, img, color);
      ims.core.vo.lookups.YesNoUnknown parentVoLookup1 = voLookup1;
      ims.domain.lookups.LookupInstance parent1 = instance1.getParent();
      while (parent1 != null) {
        if (parent1.getImage() != null) {
          img =
              new ims.framework.utils.ImagePath(
                  parent1.getImage().getImageId(), parent1.getImage().getImagePath());
        } else {
          img = null;
        }
        color = parent1.getColor();
        if (color != null) color.getValue();
        parentVoLookup1.setParent(
            new ims.core.vo.lookups.YesNoUnknown(
                parent1.getId(), parent1.getText(), parent1.isActive(), null, img, color));
        parentVoLookup1 = parentVoLookup1.getParent();
        parent1 = parent1.getParent();
      }
      valueObject.setHearingImpairment(voLookup1);
    }
    // EffectedEars
    ims.domain.lookups.LookupInstance instance2 = domainObject.getEffectedEars();
    if (null != instance2) {
      ims.framework.utils.ImagePath img = null;
      ims.framework.utils.Color color = null;
      img = null;
      if (instance2.getImage() != null) {
        img =
            new ims.framework.utils.ImagePath(
                instance2.getImage().getImageId(), instance2.getImage().getImagePath());
      }
      color = instance2.getColor();
      if (color != null) color.getValue();

      ims.core.vo.lookups.LateralityLRB voLookup2 =
          new ims.core.vo.lookups.LateralityLRB(
              instance2.getId(), instance2.getText(), instance2.isActive(), null, img, color);
      ims.core.vo.lookups.LateralityLRB parentVoLookup2 = voLookup2;
      ims.domain.lookups.LookupInstance parent2 = instance2.getParent();
      while (parent2 != null) {
        if (parent2.getImage() != null) {
          img =
              new ims.framework.utils.ImagePath(
                  parent2.getImage().getImageId(), parent2.getImage().getImagePath());
        } else {
          img = null;
        }
        color = parent2.getColor();
        if (color != null) color.getValue();
        parentVoLookup2.setParent(
            new ims.core.vo.lookups.LateralityLRB(
                parent2.getId(), parent2.getText(), parent2.isActive(), null, img, color));
        parentVoLookup2 = parentVoLookup2.getParent();
        parent2 = parent2.getParent();
      }
      valueObject.setEffectedEars(voLookup2);
    }
    // HearingAid
    ims.domain.lookups.LookupInstance instance3 = domainObject.getHearingAid();
    if (null != instance3) {
      ims.framework.utils.ImagePath img = null;
      ims.framework.utils.Color color = null;
      img = null;
      if (instance3.getImage() != null) {
        img =
            new ims.framework.utils.ImagePath(
                instance3.getImage().getImageId(), instance3.getImage().getImagePath());
      }
      color = instance3.getColor();
      if (color != null) color.getValue();

      ims.core.vo.lookups.YesNoUnknown voLookup3 =
          new ims.core.vo.lookups.YesNoUnknown(
              instance3.getId(), instance3.getText(), instance3.isActive(), null, img, color);
      ims.core.vo.lookups.YesNoUnknown parentVoLookup3 = voLookup3;
      ims.domain.lookups.LookupInstance parent3 = instance3.getParent();
      while (parent3 != null) {
        if (parent3.getImage() != null) {
          img =
              new ims.framework.utils.ImagePath(
                  parent3.getImage().getImageId(), parent3.getImage().getImagePath());
        } else {
          img = null;
        }
        color = parent3.getColor();
        if (color != null) color.getValue();
        parentVoLookup3.setParent(
            new ims.core.vo.lookups.YesNoUnknown(
                parent3.getId(), parent3.getText(), parent3.isActive(), null, img, color));
        parentVoLookup3 = parentVoLookup3.getParent();
        parent3 = parent3.getParent();
      }
      valueObject.setHearingAid(voLookup3);
    }
    // HearingAidWithPatientOnAdmission
    ims.domain.lookups.LookupInstance instance4 =
        domainObject.getHearingAidWithPatientOnAdmission();
    if (null != instance4) {
      ims.framework.utils.ImagePath img = null;
      ims.framework.utils.Color color = null;
      img = null;
      if (instance4.getImage() != null) {
        img =
            new ims.framework.utils.ImagePath(
                instance4.getImage().getImageId(), instance4.getImage().getImagePath());
      }
      color = instance4.getColor();
      if (color != null) color.getValue();

      ims.core.vo.lookups.YesNoUnknown voLookup4 =
          new ims.core.vo.lookups.YesNoUnknown(
              instance4.getId(), instance4.getText(), instance4.isActive(), null, img, color);
      ims.core.vo.lookups.YesNoUnknown parentVoLookup4 = voLookup4;
      ims.domain.lookups.LookupInstance parent4 = instance4.getParent();
      while (parent4 != null) {
        if (parent4.getImage() != null) {
          img =
              new ims.framework.utils.ImagePath(
                  parent4.getImage().getImageId(), parent4.getImage().getImagePath());
        } else {
          img = null;
        }
        color = parent4.getColor();
        if (color != null) color.getValue();
        parentVoLookup4.setParent(
            new ims.core.vo.lookups.YesNoUnknown(
                parent4.getId(), parent4.getText(), parent4.isActive(), null, img, color));
        parentVoLookup4 = parentVoLookup4.getParent();
        parent4 = parent4.getParent();
      }
      valueObject.setHearingAidWithPatientOnAdmission(voLookup4);
    }
    // BatteriesInOrder
    ims.domain.lookups.LookupInstance instance5 = domainObject.getBatteriesInOrder();
    if (null != instance5) {
      ims.framework.utils.ImagePath img = null;
      ims.framework.utils.Color color = null;
      img = null;
      if (instance5.getImage() != null) {
        img =
            new ims.framework.utils.ImagePath(
                instance5.getImage().getImageId(), instance5.getImage().getImagePath());
      }
      color = instance5.getColor();
      if (color != null) color.getValue();

      ims.core.vo.lookups.YesNoUnknown voLookup5 =
          new ims.core.vo.lookups.YesNoUnknown(
              instance5.getId(), instance5.getText(), instance5.isActive(), null, img, color);
      ims.core.vo.lookups.YesNoUnknown parentVoLookup5 = voLookup5;
      ims.domain.lookups.LookupInstance parent5 = instance5.getParent();
      while (parent5 != null) {
        if (parent5.getImage() != null) {
          img =
              new ims.framework.utils.ImagePath(
                  parent5.getImage().getImageId(), parent5.getImage().getImagePath());
        } else {
          img = null;
        }
        color = parent5.getColor();
        if (color != null) color.getValue();
        parentVoLookup5.setParent(
            new ims.core.vo.lookups.YesNoUnknown(
                parent5.getId(), parent5.getText(), parent5.isActive(), null, img, color));
        parentVoLookup5 = parentVoLookup5.getParent();
        parent5 = parent5.getParent();
      }
      valueObject.setBatteriesInOrder(voLookup5);
    }
    // YearLastHearingTest
    valueObject.setYearLastHearingTest(domainObject.getYearLastHearingTest());
    return valueObject;
  }