Class AddressServiceImpl

java.lang.Object

ch.tocco.nice2.optional.address.impl.AddressServiceImpl

All Implemented Interfaces:

AddressService, SalutationConstants

@Component
public class AddressServiceImpl
extends Object
implements AddressService, SalutationConstants

Nested Class Summary

Nested classes/interfaces inherited from interface AddressService

AddressService.AddressLook, AddressService.AddressType

Field Summary

Fields inherited from interface SalutationConstants

ACADEMIC_TITLE, DATA_OBJECT, ENTITY_APPLICATION, ENTITY_SALUTATION, ENTITY_USER, FORMAL_SALUTATION_UNIQUE_ID, GENDER, INFORMAL_SALUTATION_UNIQUE_ID, LABEL, NEUTRAL_SALUTATION_UNIQUE_ID, OTHER_TITLE, REL_ACADEMIC_TITLE, REL_ADDRESS_OUTPUT, REL_GENDER, REL_SALUTATION, REL_USER_OUTPUT, SALUTATION, SALUTATION_TITLE_PLACEHOLDER, TEMPLATE, UNIQUE_ID

Constructor Summary

Constructors

Constructor	Description
AddressServiceImpl(GroovyEvaluationService groovyEvaluationService, TemplateEngineFactory templateEngineFactory, QueryBuilderFactory queryBuilderFactory, CommandExecutor executor)

Method Summary

Modifier and Type	Method	Description
String	getAddressAsString(AddressData data, AddressService.AddressLook look, @Nullable AddressService.AddressType type)	This method implements all the logic to generate an address from a basic set of fields required for address generation.
String	getAddressAsString(Entity entity, AddressService.AddressType type, AddressService.AddressLook look)	Get a string containing the address for the provided entity
String	getAddressAsString(Entity entity, AddressService.AddressType type, AddressService.AddressLook look, String billingAddressAddition)
String	getAddressAsString(Iterable<Entity> users, AddressService.AddressType type, AddressService.AddressLook look)
String	getAddressAsStringForUser(Entity entity, AddressService.AddressType addressType, @Nullable AddressService.AddressLook look)
AddressData	getAddressData(Entity entity, AddressService.AddressType type, AddressService.AddressLook look)	Gets a populated AddressData object for the given entity, address type and address look.
AddressDataProvider	getAddressDataProvider(String entityName)
Entity	getAddressForUser(Entity userEntity, AddressService.AddressType addressType)	Get an Address entity for the provided User entity
String	getAddressWithAltUser(Entity altAddress, Entity user, AddressService.AddressType addressType, AddressService.AddressLook look, @Nullable String billingAddressAdditionUser, @Nullable String billingAddressAdditionOther)	Prepares data for function "getAddressAsString" Usage: In Correspondence, when an alternative correspondenceaddress is set.
String	getFullName(AddressData data, boolean withTitle)
String	getFullName(Entity entity)
String	getFullName(Entity entity, boolean withTitle)
String	getSalutation(AddressData data)	This method implements the logic to generate a salutation line for a given AddressData object.
String	getSalutation(Entity entity)	Get a string containing the salutation line for the provided entity
String	getSalutation(Entity entity, @Nullable Entity sender)
String	getSalutation(Iterable<Entity> users, @Nullable Entity sender)	Returns the salutation string for a list of users.
boolean	isCasualForm(@Nullable Entity sender, Entity recipient)
boolean	isPoliteForm(@Nullable Entity sender, Entity recipient)
@Nullable Entity	resolveAddressAddressAcceptor(@Nullable Entity address, AddressService.AddressType addressType)	Get the address that is linked as "recipient" of the parameter address using Address_address with the appropriate "Acceptor" for a given AddressType.
Optional<Entity>	retrieveAddressUser(Entity user, @Nullable Entity address)
void	setAddressDataProviders(List<AddressDataProvider> dataProviders)
void	setUserSalutation(AddressData data)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AddressServiceImpl

public AddressServiceImpl(GroovyEvaluationService groovyEvaluationService,
 TemplateEngineFactory templateEngineFactory,
 QueryBuilderFactory queryBuilderFactory,
 CommandExecutor executor)

Method Details

getAddressAsString

public String getAddressAsString(Entity entity,
 AddressService.AddressType type,
 AddressService.AddressLook look)

Description copied from interface: AddressService

Get a string containing the address for the provided entity

Specified by:

getAddressAsString in interface AddressService

Parameters:

entity - entity containing the address information to print

type - type enum - see enum for details

look - look enum - see enum for details

Returns:

the address string

getAddressAsString

public String getAddressAsString(Entity entity,
 AddressService.AddressType type,
 AddressService.AddressLook look,
 String billingAddressAddition)

Specified by:

getAddressAsString in interface AddressService

getAddressAsString

public String getAddressAsString(Iterable<Entity> users,
 AddressService.AddressType type,
 AddressService.AddressLook look)

Specified by:

getAddressAsString in interface AddressService

Parameters:

users - multiple `User` entities that are all linked to the same address

Returns:

an address block, where the fullnames of the persons are concatenated

getSalutation

public String getSalutation(Iterable<Entity> users,
 @Nullable
 @Nullable Entity sender)

Description copied from interface: AddressService

Returns the salutation string for a list of users. The user entities must be linked to the same address.

Specified by:

getSalutation in interface AddressService

Parameters:

sender - optional sender, used to inspect person-to-person salutation

getAddressForUser

public Entity getAddressForUser(Entity userEntity,
 AddressService.AddressType addressType)

Description copied from interface: AddressService

Get an Address entity for the provided User entity

Specified by:

getAddressForUser in interface AddressService

Parameters:

userEntity - the user entity

addressType - type enum - see enum for details

Returns:

an Address entity

resolveAddressAddressAcceptor

@Nullable
public @Nullable Entity resolveAddressAddressAcceptor(@Nullable
 @Nullable Entity address,
 AddressService.AddressType addressType)

Description copied from interface: AddressService

Get the address that is linked as "recipient" of the parameter address using Address_address with the appropriate "Acceptor" for a given AddressType. If the input address is null, null is returned.

Specified by:

resolveAddressAddressAcceptor in interface AddressService

Parameters:

address - the address to resolve

addressType - the address type used to select the proper Acceptor

Returns:

either the input address or the linked address if available.

getSalutation

public String getSalutation(Entity entity)

Description copied from interface: AddressService

Get a string containing the salutation line for the provided entity

Specified by:

getSalutation in interface AddressService

Parameters:

entity - entity containing the salutation information

Returns:

the salutation string

getSalutation

public String getSalutation(Entity entity,
 @Nullable
 @Nullable Entity sender)

Specified by:

getSalutation in interface AddressService

getAddressAsString

public String getAddressAsString(AddressData data,
 AddressService.AddressLook look,
 @Nullable
 @Nullable AddressService.AddressType type)

This method implements all the logic to generate an address from a basic set of fields required for address generation.

Specified by:

getAddressAsString in interface AddressService

Returns:

the generated address as a String

getAddressAsStringForUser

public String getAddressAsStringForUser(Entity entity,
 AddressService.AddressType addressType,
 @Nullable
 @Nullable AddressService.AddressLook look)

Specified by:

getAddressAsStringForUser in interface AddressService

getAddressWithAltUser

public String getAddressWithAltUser(Entity altAddress,
 Entity user,
 AddressService.AddressType addressType,
 AddressService.AddressLook look,
 @Nullable
 @Nullable String billingAddressAdditionUser,
 @Nullable
 @Nullable String billingAddressAdditionOther)

Prepares data for function "getAddressAsString" Usage: In Correspondence, when an alternative correspondenceaddress is set.

Specified by:

getAddressWithAltUser in interface AddressService

getAddressDataProvider

public AddressDataProvider getAddressDataProvider(String entityName)

Specified by:

getAddressDataProvider in interface AddressService

getSalutation

public String getSalutation(AddressData data)

This method implements the logic to generate a salutation line for a given AddressData object.

Note: This method could potentially be made public and moved to the interface to enable salutation generation from a "manually" created AddressData object.

retrieveAddressUser

public Optional<Entity> retrieveAddressUser(Entity user,
 @Nullable
 @Nullable Entity address)

Specified by:

retrieveAddressUser in interface AddressService

setUserSalutation

public void setUserSalutation(AddressData data)

isPoliteForm

public boolean isPoliteForm(@Nullable
 @Nullable Entity sender,
 Entity recipient)

Specified by:

isPoliteForm in interface AddressService

isCasualForm

public boolean isCasualForm(@Nullable
 @Nullable Entity sender,
 Entity recipient)

Specified by:

isCasualForm in interface AddressService

getFullName

public String getFullName(Entity entity,
 boolean withTitle)

Specified by:

getFullName in interface AddressService

getFullName

public String getFullName(Entity entity)

Specified by:

getFullName in interface AddressService

getFullName

public String getFullName(AddressData data,
 boolean withTitle)

getAddressData

public AddressData getAddressData(Entity entity,
 @Nullable
 AddressService.AddressType type,
 @Nullable
 AddressService.AddressLook look)

Gets a populated AddressData object for the given entity, address type and address look.

Specified by:

getAddressData in interface AddressService

setAddressDataProviders

@Autowired
public void setAddressDataProviders(List<AddressDataProvider> dataProviders)