/*-

* #%L
* BroadleafCommerce Profile
* %%
* Copyright (C) 2009 - 2025 Broadleaf Commerce
* %%
* Licensed under the Broadleaf Fair Use License Agreement, Version 1.0
* (the "Fair Use License" located at
http://license.broadleafcommerce.org/fair_use_license-1.0.txt)
* unless the restrictions on use therein are violated and require payment to
Broadleaf in which case
* the Broadleaf End User License Agreement (EULA), Version 1.1
* (the "Commercial License" located at
http://license.broadleafcommerce.org/commercial_license-1.1.txt)
* shall apply.
*
* Alternatively, the Commercial License may be replaced with a mutually agreed
upon license (the "Custom License")
* between you and Broadleaf Commerce. You may not use this file except in
compliance with the applicable license.
* #L%
*/
package org.broadleafcommerce.profile.core.domain;

import org.broadleafcommerce.common.copy.CreateResponse;
import org.broadleafcommerce.common.copy.MultiTenantCopyContext;
import org.broadleafcommerce.common.i18n.domain.ISOCountry;
import org.broadleafcommerce.common.i18n.domain.ISOCountryImpl;
import org.broadleafcommerce.common.persistence.IdOverrideTableGenerator;
import org.broadleafcommerce.common.presentation.AdminPresentation;
import org.broadleafcommerce.common.presentation.AdminPresentationClass;
import org.broadleafcommerce.common.presentation.AdminPresentationToOneLookup;
import org.broadleafcommerce.common.presentation.PopulateToOneFieldsEnum;
import org.broadleafcommerce.common.presentation.client.VisibilityEnum;
import
org.broadleafcommerce.common.presentation.override.AdminPresentationMergeEntry;
import
org.broadleafcommerce.common.presentation.override.AdminPresentationMergeOverride;
import
org.broadleafcommerce.common.presentation.override.AdminPresentationMergeOverrides;
import org.broadleafcommerce.common.presentation.override.PropertyType;
import org.broadleafcommerce.common.time.domain.TemporalTimestampListener;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.GenericGenerator;
import org.hibernate.annotations.Parameter;

import java.io.Serial;

import jakarta.persistence.CascadeType;
import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.EntityListeners;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.Id;
import jakarta.persistence.Index;
import jakarta.persistence.Inheritance;
import jakarta.persistence.InheritanceType;
import jakarta.persistence.JoinColumn;
import jakarta.persistence.ManyToOne;
import jakarta.persistence.Table;

@Entity
@EntityListeners(value = {TemporalTimestampListener.class})
@Inheritance(strategy = InheritanceType.JOINED)
@Table(name = "BLC_ADDRESS", indexes = {
@Index(name = "ADDRESS_ISO_COUNTRY_IDX", columnList =
"ISO_COUNTRY_ALPHA2"),
@Index(name = "ADDRESS_PHONE_PRI_IDX", columnList = "PHONE_PRIMARY_ID"),
@Index(name = "ADDRESS_PHONE_SEC_IDX", columnList = "PHONE_SECONDARY_ID"),
@Index(name = "ADDRESS_PHONE_FAX_IDX", columnList = "PHONE_FAX_ID"),
@Index(name = "ADDRESS_COUNTY_INDEX", columnList = "COUNTY")
})
@AdminPresentationMergeOverrides({
@AdminPresentationMergeOverride(name = "phonePrimary", mergeEntries =
@AdminPresentationMergeEntry(propertyType =
PropertyType.AdminPresentation.EXCLUDED,
booleanOverrideValue = true)),
@AdminPresentationMergeOverride(name = "phoneSecondary", mergeEntries =
@AdminPresentationMergeEntry(propertyType =
PropertyType.AdminPresentation.EXCLUDED,
booleanOverrideValue = true)),
@AdminPresentationMergeOverride(name = "phoneFax", mergeEntries =
@AdminPresentationMergeEntry(propertyType =
PropertyType.AdminPresentation.EXCLUDED,
booleanOverrideValue = true)),
@AdminPresentationMergeOverride(name = "phonePrimary.phoneNumber",
mergeEntries = {
@AdminPresentationMergeEntry(propertyType =
PropertyType.AdminPresentation.EXCLUDED,
booleanOverrideValue = false),
@AdminPresentationMergeEntry(propertyType =
PropertyType.AdminPresentation.ORDER,
intOverrideValue = 1300),
@AdminPresentationMergeEntry(
propertyType =
PropertyType.AdminPresentation.REQUIREDOVERRIDE,
overrideValue = "NOT_REQUIRED"),
@AdminPresentationMergeEntry(
propertyType = PropertyType.AdminPresentation.FRIENDLYNAME,
overrideValue = "PhoneImpl_Primary_Phone")}),
@AdminPresentationMergeOverride(name = "phoneSecondary.phoneNumber",
mergeEntries = {
@AdminPresentationMergeEntry(propertyType =
PropertyType.AdminPresentation.EXCLUDED,
booleanOverrideValue = false),
@AdminPresentationMergeEntry(propertyType =
PropertyType.AdminPresentation.ORDER,
intOverrideValue = 1400),
@AdminPresentationMergeEntry(
propertyType =
PropertyType.AdminPresentation.REQUIREDOVERRIDE,
overrideValue = "NOT_REQUIRED"),
@AdminPresentationMergeEntry(
propertyType = PropertyType.AdminPresentation.FRIENDLYNAME,
overrideValue = "PhoneImpl_Secondary_Phone")}),
@AdminPresentationMergeOverride(name = "phoneFax.phoneNumber", mergeEntries
= {
 @AdminPresentationMergeEntry(propertyType =
PropertyType.AdminPresentation.EXCLUDED,
booleanOverrideValue = false),
@AdminPresentationMergeEntry(propertyType =
PropertyType.AdminPresentation.ORDER,
intOverrideValue = 1500),
@AdminPresentationMergeEntry(
propertyType =
PropertyType.AdminPresentation.REQUIREDOVERRIDE,
overrideValue = "NOT_REQUIRED"),
@AdminPresentationMergeEntry(
propertyType = PropertyType.AdminPresentation.FRIENDLYNAME,
overrideValue = "PhoneImpl_Fax_Phone")}),
@AdminPresentationMergeOverride(name = "state", mergeEntries =
@AdminPresentationMergeEntry(propertyType =
PropertyType.AdminPresentation.EXCLUDED,
booleanOverrideValue = true)),
@AdminPresentationMergeOverride(name = "country", mergeEntries =
@AdminPresentationMergeEntry(propertyType =
PropertyType.AdminPresentation.EXCLUDED,
booleanOverrideValue = true))
})
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE, region = "blOrderElements")
@AdminPresentationClass(populateToOneFields = PopulateToOneFieldsEnum.TRUE,
friendlyName = "AddressImpl_baseAddress")
public class AddressImpl implements Address {

@Serial
private static final long serialVersionUID = 1L;

@Id
@GeneratedValue(generator = "AddressId")
@GenericGenerator(
name = "AddressId",
type = IdOverrideTableGenerator.class,
parameters = {
@Parameter(name = "segment_value", value = "AddressImpl"),
@Parameter(name = "entity_name",
value =
"org.broadleafcommerce.profile.core.domain.AddressImpl")
}
)
@Column(name = "ADDRESS_ID")
protected Long id;

@Column(name = "FULL_NAME")
@AdminPresentation(friendlyName = "AddressImpl_Full_Name", order = 10, group =
"AddressImpl_Address")
protected String fullName;

@Column(name = "FIRST_NAME")
@AdminPresentation(friendlyName = "AddressImpl_First_Name", order = 10, group =
"AddressImpl_Address")
protected String firstName;

@Column(name = "LAST_NAME")
@AdminPresentation(friendlyName = "AddressImpl_Last_Name", order = 20, group =
"AddressImpl_Address")
protected String lastName;
 @Column(name = "EMAIL_ADDRESS")
@AdminPresentation(friendlyName = "AddressImpl_Email_Address", order = 30,
group = "AddressImpl_Address")
protected String emailAddress;

@Column(name = "COMPANY_NAME")
@AdminPresentation(friendlyName = "AddressImpl_Company_Name", order = 40, group
= "AddressImpl_Address")
protected String companyName;

@Column(name = "ADDRESS_LINE1", nullable = false)

@AdminPresentation(friendlyName = "AddressImpl_Address_1", order = 50, group =
"AddressImpl_Address")
protected String addressLine1;

@Column(name = "ADDRESS_LINE2")
@AdminPresentation(friendlyName = "AddressImpl_Address_2", order = 60, group =
"AddressImpl_Address")
protected String addressLine2;

@Column(name = "ADDRESS_LINE3")
@AdminPresentation(friendlyName = "AddressImpl_Address_3", order = 60, group =
"AddressImpl_Address")
protected String addressLine3;

@Column(name = "CITY", nullable = false)

@AdminPresentation(friendlyName = "AddressImpl_City", order = 70, group =
"AddressImpl_Address")
protected String city;

@Column(name = "ISO_COUNTRY_SUB")
@AdminPresentation(friendlyName = "AddressImpl_Country_Subdivision", order =
110, group = "AddressImpl_Address",
tooltip = "AddressImpl_Country_Subdivision_ToolTip")
protected String isoCountrySubdivision;

@Column(name = "SUB_STATE_PROV_REG")
@AdminPresentation(friendlyName = "AddressImpl_State_Province_Region", order =
80, group = "AddressImpl_Address")
protected String stateProvinceRegion;

@Column(name = "COUNTY")
@AdminPresentation(friendlyName = "AddressImpl_County", order = 90, group =
"AddressImpl_Address")
protected String county;

@ManyToOne(cascade = {CascadeType.PERSIST, CascadeType.MERGE}, targetEntity =

ISOCountryImpl.class)
@JoinColumn(name = "ISO_COUNTRY_ALPHA2")
@AdminPresentation(friendlyName = "AddressImpl_Country_Alpha2", order = 100,
group = "AddressImpl_Address")
@AdminPresentationToOneLookup
protected ISOCountry isoCountryAlpha2;

@Column(name = "POSTAL_CODE")
@AdminPresentation(friendlyName = "AddressImpl_Postal_Code", order = 120, group
= "AddressImpl_Address")
protected String postalCode;
 @Column(name = "ZIP_FOUR")
@AdminPresentation(friendlyName = "AddressImpl_Four_Digit_Zip", order = 130,
group = "AddressImpl_Address")
protected String zipFour;

@ManyToOne(targetEntity = PhoneImpl.class, cascade = {CascadeType.PERSIST,

CascadeType.MERGE, CascadeType.REFRESH})
@JoinColumn(name = "PHONE_PRIMARY_ID")
protected Phone phonePrimary;

@ManyToOne(targetEntity = PhoneImpl.class, cascade = {CascadeType.PERSIST,

CascadeType.MERGE, CascadeType.REFRESH})
@JoinColumn(name = "PHONE_SECONDARY_ID")
protected Phone phoneSecondary;

@ManyToOne(targetEntity = PhoneImpl.class, cascade = {CascadeType.PERSIST,

CascadeType.MERGE, CascadeType.REFRESH})
@JoinColumn(name = "PHONE_FAX_ID")
protected Phone phoneFax;

@Column(name = "IS_DEFAULT")
@AdminPresentation(friendlyName = "AddressImpl_Default_Address", order = 160,
group = "AddressImpl_Address")
protected boolean isDefault = false;

@Column(name = "IS_ACTIVE")
@AdminPresentation(friendlyName = "AddressImpl_Active_Address", order = 170,
group = "AddressImpl_Address")
protected boolean isActive = true;

@Column(name = "IS_BUSINESS")
@AdminPresentation(friendlyName = "AddressImpl_Business_Address", order = 180,
group = "AddressImpl_Address")
protected boolean isBusiness = false;

/**
* Intended to be used to differentiate whether this address is a physical
address (e.g.
* street/house) or a mailing address (e.g. P.O. Box etc..)
*/
@Column(name = "IS_STREET")
@AdminPresentation(friendlyName = "AddressImpl_Street_Address", order = 220,
group = "AddressImpl_Address")
protected boolean isStreet = false;

/**
* Intended to be used to differentiate whether this address is a physical
address (e.g.
* street/house) or a mailing address (e.g. P.O. Box etc..)
*/
@Column(name = "IS_MAILING")
@AdminPresentation(friendlyName = "AddressImpl_Mailing_Address", order = 230,
group = "AddressImpl_Address")
protected boolean isMailing = false;

/**
* This is intented to be used for address verification integrations and should
not be
 * modifiable in the admin
*/
@Column(name = "TOKENIZED_ADDRESS")
@AdminPresentation(friendlyName = "AddressImpl_Tokenized_Address", order = 190,
group = "AddressImpl_Address", visibility = VisibilityEnum.HIDDEN_ALL)
protected String tokenizedAddress;

/**
* This is intented to be used for address verification integrations and should
not be
* modifiable in the admin
*/
@Column(name = "STANDARDIZED")
@AdminPresentation(friendlyName = "AddressImpl_Standardized", order = 200,
group = "AddressImpl_Address", visibility = VisibilityEnum.HIDDEN_ALL)
protected Boolean standardized = Boolean.FALSE;

/**
* This is intented to be used for address verification integrations and should
not be
* modifiable in the admin
*/
@Column(name = "VERIFICATION_LEVEL")
@AdminPresentation(friendlyName = "AddressImpl_Verification_Level", order =
210,
group = "AddressImpl_Address", visibility = VisibilityEnum.HIDDEN_ALL)
protected String verificationLevel;

@Column(name = "PRIMARY_PHONE")
@Deprecated
protected String primaryPhone;

@Column(name = "SECONDARY_PHONE")
@Deprecated
protected String secondaryPhone;

@Column(name = "FAX")
@Deprecated
protected String fax;

@Override
public Long getId() {
return id;
}

@Override
public void setId(Long id) {
this.id = id;
}

@Override
public String getAddressLine1() {
return addressLine1;
}

@Override
public void setAddressLine1(String addressLine1) {
this.addressLine1 = addressLine1;
}
@Override
public String getAddressLine2() {
return addressLine2;
}

@Override
public void setAddressLine2(String addressLine2) {
this.addressLine2 = addressLine2;
}

@Override
public String getAddressLine3() {
return addressLine3;
}

@Override
public void setAddressLine3(String addressLine3) {
this.addressLine3 = addressLine3;
}

@Override
public String getCity() {
return city;
}

@Override
public void setCity(String city) {
this.city = city;
}

@Override
public String getIsoCountrySubdivision() {
return isoCountrySubdivision;
}

@Override
public void setIsoCountrySubdivision(String isoCountrySubdivision) {
this.isoCountrySubdivision = isoCountrySubdivision;
}

@Override
public String getStateProvinceRegion() {
return stateProvinceRegion;
}

@Override
public void setStateProvinceRegion(String stateProvinceRegion) {
this.stateProvinceRegion = stateProvinceRegion;
}

@Override
public ISOCountry getIsoCountryAlpha2() {
return isoCountryAlpha2;
}

@Override
public void setIsoCountryAlpha2(ISOCountry isoCountryAlpha2) {
this.isoCountryAlpha2 = isoCountryAlpha2;
}

@Override
public String getPostalCode() {
return postalCode;
}

@Override
public void setPostalCode(String postalCode) {
this.postalCode = postalCode;
}

@Override
public String getCounty() {
return county;
}

@Override
public void setCounty(String county) {
this.county = county;
}

@Override
public String getTokenizedAddress() {
return tokenizedAddress;
}

@Override
public void setTokenizedAddress(String tokenizedAddress) {
this.tokenizedAddress = tokenizedAddress;
}

@Override
public Boolean getStandardized() {
return standardized;
}

@Override
public void setStandardized(Boolean standardized) {
this.standardized = standardized;
}

@Override
public String getZipFour() {
return zipFour;
}

@Override
public void setZipFour(String zipFour) {
this.zipFour = zipFour;
}

@Override
public String getCompanyName() {
return companyName;
}

@Override
public void setCompanyName(String companyName) {
 this.companyName = companyName;
}

@Override
public boolean isDefault() {
return isDefault;
}

@Override
public void setDefault(boolean isDefault) {
this.isDefault = isDefault;
}

@Override
public boolean isActive() {
return isActive;
}

@Override
public void setActive(boolean isActive) {
this.isActive = isActive;
}

@Override
public String getFullName() {
return fullName;
}

@Override
public void setFullName(String fullName) {
this.fullName = fullName;
}

@Override
public String getFirstName() {
return firstName;
}

@Override
public void setFirstName(String firstName) {
this.firstName = firstName;
}

@Override
public String getLastName() {
return lastName;
}

@Override
public void setLastName(String lastName) {
this.lastName = lastName;
}

@Override
@Deprecated
public String getPrimaryPhone() {
return primaryPhone;
}
 @Override
@Deprecated
public void setPrimaryPhone(String primaryPhone) {
this.primaryPhone = primaryPhone;
}

@Override
@Deprecated
public String getSecondaryPhone() {
return secondaryPhone;
}

@Override
@Deprecated
public void setSecondaryPhone(String secondaryPhone) {
this.secondaryPhone = secondaryPhone;
}

@Override
@Deprecated
public String getFax() {
return this.fax;
}

@Override
@Deprecated
public void setFax(String fax) {
this.fax = fax;
}

@Override
public Phone getPhonePrimary() {
Phone legacyPhone = new PhoneImpl();
legacyPhone.setPhoneNumber(this.primaryPhone);
return (phonePrimary == null && this.primaryPhone != null) ? legacyPhone :
phonePrimary;
}

@Override
public void setPhonePrimary(Phone phonePrimary) {
this.phonePrimary = phonePrimary;
}

@Override
public Phone getPhoneSecondary() {
Phone legacyPhone = new PhoneImpl();
legacyPhone.setPhoneNumber(this.secondaryPhone);
return (phoneSecondary == null && this.secondaryPhone != null)
? legacyPhone
: phoneSecondary;
}

@Override
public void setPhoneSecondary(Phone phoneSecondary) {
this.phoneSecondary = phoneSecondary;
}

@Override
public Phone getPhoneFax() {
 Phone legacyPhone = new PhoneImpl();
legacyPhone.setPhoneNumber(this.fax);
return (phoneFax == null && this.fax != null) ? legacyPhone : phoneFax;
}

@Override
public void setPhoneFax(Phone phoneFax) {
this.phoneFax = phoneFax;
}

@Override
public boolean isBusiness() {
return isBusiness;
}

@Override
public void setBusiness(boolean isBusiness) {
this.isBusiness = isBusiness;
}

@Override
public boolean isStreet() {
return isStreet;
}

@Override
public void setStreet(boolean isStreet) {
this.isStreet = isStreet;
}

@Override
public boolean isMailing() {
return isMailing;
}

@Override
public void setMailing(boolean isMailing) {
this.isMailing = isMailing;
}

@Override
public String getVerificationLevel() {
return verificationLevel;
}

@Override
public void setVerificationLevel(String verificationLevel) {
this.verificationLevel = verificationLevel;
}

@Override
public String getEmailAddress() {
return this.emailAddress;
}

@Override
public void setEmailAddress(String emailAddress) {
this.emailAddress = emailAddress;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (!getClass().isAssignableFrom(obj.getClass()))
return false;
AddressImpl other = (AddressImpl) obj;

if (id != null && other.id != null) {

return id.equals(other.id);
}

if (addressLine1 == null) {
if (other.addressLine1 != null)
return false;
} else if (!addressLine1.equals(other.addressLine1))
return false;
if (addressLine2 == null) {
if (other.addressLine2 != null)
return false;
} else if (!addressLine2.equals(other.addressLine2))
return false;
if (city == null) {
if (other.city != null)
return false;
} else if (!city.equals(other.city))
return false;
if (companyName == null) {
if (other.companyName != null)
return false;
} else if (!companyName.equals(other.companyName))
return false;
if (isoCountryAlpha2 == null) {
if (other.isoCountryAlpha2 != null)
return false;
} else if (!isoCountryAlpha2.equals(other.isoCountryAlpha2))
return false;
if (county == null) {
if (other.county != null)
return false;
} else if (!county.equals(other.county))
return false;
if (fullName == null) {
if (other.fullName != null)
return false;
} else if (!fullName.equals(other.fullName))
return false;
if (firstName == null) {
if (other.firstName != null)
return false;
} else if (!firstName.equals(other.firstName))
return false;
if (lastName == null) {
if (other.lastName != null)
return false;
} else if (!lastName.equals(other.lastName))
 return false;
if (postalCode == null) {
if (other.postalCode != null)
return false;
} else if (!postalCode.equals(other.postalCode))
return false;
if (isoCountrySubdivision == null) {
if (other.isoCountrySubdivision != null)
return false;
} else if (!isoCountrySubdivision.equals(other.isoCountrySubdivision))
return false;
if (stateProvinceRegion == null) {
if (other.stateProvinceRegion != null)
return false;
} else if (!stateProvinceRegion.equals(other.stateProvinceRegion))
return false;
return true;
}

@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((id == null) ? 0 : id.hashCode());
result = prime * result + ((addressLine1 == null) ? 0 :
addressLine1.hashCode());
result = prime * result + ((addressLine2 == null) ? 0 :
addressLine2.hashCode());
result = prime * result + ((city == null) ? 0 : city.hashCode());
result = prime * result + ((companyName == null) ? 0 :
companyName.hashCode());
result = prime * result + ((isoCountryAlpha2 == null) ? 0 :
isoCountryAlpha2.hashCode());
result = prime * result + ((county == null) ? 0 : county.hashCode());
result = prime * result + ((fullName == null) ? 0 : fullName.hashCode());
result = prime * result + ((firstName == null) ? 0 : firstName.hashCode());
result = prime * result + ((lastName == null) ? 0 : lastName.hashCode());
result = prime * result + ((postalCode == null) ? 0 :
postalCode.hashCode());
result = prime * result + ((isoCountrySubdivision == null)
? 0
: isoCountrySubdivision.hashCode());
result = prime * result + ((stateProvinceRegion == null)
? 0
: stateProvinceRegion.hashCode());
return result;
}

@Override
public <G extends Address> CreateResponse<G>
createOrRetrieveCopyInstance(MultiTenantCopyContext context)
throws CloneNotSupportedException {
CreateResponse<G> createResponse =
context.createOrRetrieveCopyInstance(this);
if (createResponse.isAlreadyPopulated()) {
return createResponse;
}
Address cloned = createResponse.getClone();
cloned.setActive(isActive);
 cloned.setAddressLine1(addressLine1);
cloned.setAddressLine2(addressLine2);
cloned.setAddressLine3(addressLine3);
cloned.setBusiness(isBusiness);
cloned.setCity(city);
cloned.setCompanyName(companyName);
cloned.setCounty(county);
cloned.setDefault(isDefault);
cloned.setEmailAddress(emailAddress);
cloned.setFirstName(firstName);
cloned.setLastName(lastName);
cloned.setFullName(fullName);
cloned.setIsoCountryAlpha2(isoCountryAlpha2);
cloned.setIsoCountrySubdivision(isoCountrySubdivision);
cloned.setStreet(isStreet);
cloned.setZipFour(zipFour);
cloned.setPhoneFax(phoneFax);
cloned.setPhonePrimary(phonePrimary);
cloned.setPostalCode(postalCode);
cloned.setFax(fax);
cloned.setMailing(isMailing);
cloned.setStandardized(standardized);
cloned.setTokenizedAddress(tokenizedAddress);
cloned.setVerificationLevel(verificationLevel);
cloned.setStateProvinceRegion(stateProvinceRegion);
cloned.setPhoneSecondary(phoneSecondary);
return createResponse;
}