fr.inra.agrosyst.api.services.domain

Interface DomainService

All Superinterfaces:

AgrosystService

public interface DomainService
extends AgrosystService

Domain service.

Author:

Eric Chatellier

Field Summary

Fields

Modifier and Type	Field and Description
static String	NEW_EQUIPMENT

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkDomainExistence(String domainName) Check if a domain already exists if specified name.
List<String>	copyTools(String fromDomain, List<String> toDomains, Boolean includeToolCouplings, List<Equipment> equipmentsToCopy, List<ToolsCoupling> toolsCouplingsToCopy) Copy equipments and optionally tools couplings and manuals interventions from domain the given fromDomain to domain the given toDomains list
Domain	createOrUpdateDomain(Domain domain, String locationId, String legalStatusId, List<GeoPoint> gpsData, List<CroppingPlanEntryDto> croppingPlan, Integer otex18, Integer otex70, List<Ground> grounds, List<Equipment> equipments, List<ToolsCoupling> toolsCouplings, List<Price> prices)
void	deleteToolsCouplings(Collection<ToolsCoupling> toolsCouplings) delete Tools couplings and the associated object
void	deleteUnusedMainAction(String toolsCouplingCode, Collection<RefInterventionAgrosystTravailEDI> originalMainsActions, Collection<RefInterventionAgrosystTravailEDI> actualMainsActions) delete related object to the actions that are no more used
InputStream	exportDomainAsXlsStream(List<String> domainIds) Export selected domains id as excel sheet.
Domain	extendDomain(String domainTopiaId, int extendCampaign) Extend domain for specified campaign.
List<String>	findDomainIdsForCodeAndCampaigns(String code, Set<Integer> campaigns, boolean includeCropsFromInactiveDomains) return all domains TopiaId that match the domain code given as parameter for the given campaigns range.
RefStationMeteo	findRefStationMeteoByTopiaId(String topiaId) Find the RefStationMeteo instance by a given TopiaEntity.getTopiaId().
Map<String,org.apache.commons.lang3.tuple.Pair<CroppingPlanEntry,Map<String,CroppingPlanSpecies>>>	findSpeciesCodeByCropCodeForCampaigns(List<String> croppingPlanEntryCodes, Set<Integer> campaignsSet)
List<Domain>	getActiveWritableDomainsForDecisionRuleCreation() Do not use this method to get writable domains, this is only usable on DecisionRule creation ! See https://forge.codelutin.com/issues/4439#note-6
List<Domain>	getAllDomains() Find all domain.
List<RefLegalStatus>	getAllRefLegalStatus() Find all LegalStaus
List<String>	getCroppingPlanCodeForDomainsAndCampaigns(String code, Set<Integer> campaigns) List of CroppingPlan's Codes for domains with code the given code and for given campaigns.
List<CroppingPlanEntryDto>	getCroppingPlanDtos(String domainId) Get the list of cropping plan (assolement) of the given domain containing only main crops (not intermediate).
UsageList<CroppingPlanEntryDto>	getCroppingPlanEntryDtoAndUsage(String domainId) The CroppingPlanEntryDto UsageList from domain with id the given domainId.
List<String>	getCroppingPlanSpeciesCodeForCropCodeAndCampaigns(String cropCode, Set<Integer> campaigns)
Map<String,Boolean>	getCroppingPlanSpeciesUsage(String domainId) All CroppingPlanSpecies Ids and there usage status
Domain	getDomain(String domainId) Find a specific domain from identifier.
DomainDto	getDomainByCode(String domainCode) Find random domain by code.
String	getDomainCodeForGrowingSystem(String growingSystemId) return the domain code associated to the growing system with topiaId the growingSystemId parameters.
List<Price>	getDomainPrices(String domainTopiaId)
List<DomainDto>	getDomains(Collection<String> domainIds)
double	getDomainSAUArea(String domainId) Get domain'plots total area.
long	getDomainsCount(Boolean active) Return the number of domains
List<Domain>	getDomainWithName(String name)
org.apache.commons.lang3.tuple.Pair<CroppingPlanEntry,Map<String,CroppingPlanSpecies>>	getEntryAndSpeciesFromCode(String croppingPlanEntryCode, Set<Integer> campaignsSet) Charge les couples cultures/especes à partir du code de l'espèce et d'un Set de campagnes
List<Equipment>	getEquipments(String domainId)
ResultList<Domain>	getFilteredDomains(DomainFilter filter) Find domain matching user filter and navigation context.
ResultList<DomainDto>	getFilteredDomainsDto(DomainFilter filter) Find domain matching user filter and navigation context.
List<GeoPoint>	getGeoPoints(String domainId) return GeoPoint for domain with id the given domainId Data are anonymize if user has no right to see them
List<Ground>	getGrounds(String domainId)
LinkedHashMap<Integer,String>	getRelatedDomains(String domainCode) Get domain related to current domain.
UsageList<ToolsCoupling>	getToolsCouplingAndUsage(String domainId) The tools coupling UsageList from domain with id the given domainId.
List<String>	getToolsCouplingCodeForDomainsAndCampaigns(String code, Set<Integer> campaigns) list of ToolsCoupling's Codes for domains with code the given code and for given campaigns.
List<ToolsCoupling>	getToolsCouplings(String domainId)
List<ToolsCoupling>	getToolsCouplingsForDomainCodeAndCampaigns(String code, Set<Integer> campaigns) List of ToolsCouplings for domains with code the given code and for given campaigns.
void	importDomainForXlsStream(InputStream is) Import domain from input stream
void	importPZ0Domains(Map<Class,ImportResults> allResult) Try to Import domains created from from PZ0 csv
Domain	newDomain() Create a new (empty) Domain entity.
GeoPoint	newGpsData() Create a new (empty) GPSData entity.
Equipment	newMateriel() Create new instance of domain materiel.
Ground	newSol() Create sol instance.
ToolsCoupling	newToolsCoupling() Create ToolsCoupling instance.
WeatherStation	newWeatherStation() Creates a new (empty) WeatherStation.
void	unactivateDomains(List<String> domainIds, boolean activate) Unactivate or reactivate the given domains.
Domain	validateAndCommit(String domainId) Do validate the current domain state

Field Detail

NEW_EQUIPMENT

static final String NEW_EQUIPMENT

See Also:

Constant Field Values

Method Detail

getAllDomains

List<Domain> getAllDomains()

Find all domain.

Returns:

all domains

newDomain

Domain newDomain()

Create a new (empty) Domain entity. the returned instance is not persisted yet.

Returns:

the newly created instance

newGpsData

GeoPoint newGpsData()

Create a new (empty) GPSData entity. the return instance is not persited yed.

Returns:

the newly created instance

newWeatherStation

WeatherStation newWeatherStation()

Creates a new (empty) WeatherStation.

This returned instance is not persisted yet.

Returns:

the newly created WeatherStation instance

getDomain

Domain getDomain(String domainId)

Find a specific domain from identifier.

Parameters:

domainId - domain id

Returns:

domain

getDomainByCode

DomainDto getDomainByCode(String domainCode)

Find random domain by code.

Parameters:

domainCode - domain code

Returns:

random domain for code

createOrUpdateDomain

Domain createOrUpdateDomain(Domain domain,
                          String locationId,
                          String legalStatusId,
                          List<GeoPoint> gpsData,
                          List<CroppingPlanEntryDto> croppingPlan,
                          Integer otex18,
                          Integer otex70,
                          List<Ground> grounds,
                          List<Equipment> equipments,
                          List<ToolsCoupling> toolsCouplings,
                          List<Price> prices)

Parameters:

domain - domain

locationId - RefLocation's topiaID associated to the domain

legalStatusId - RefLegalStatus topiaId

gpsData - Domain's geoPoints

croppingPlan - Domain's crops

otex18 - otext 18 code

otex70 - otex 70 code

grounds - Domain's ground

equipments - Domain"s Equipment

toolsCouplings - Domain's tools couplings

prices - Domain's crop's and fuel prices

Returns:

persisted domain

getFilteredDomains

ResultList<Domain> getFilteredDomains(DomainFilter filter)

Find domain matching user filter and navigation context.

Parameters:

filter - custom user filter

Returns:

matching domains

getDomainWithName

List<Domain> getDomainWithName(String name)

getFilteredDomainsDto

ResultList<DomainDto> getFilteredDomainsDto(DomainFilter filter)

Find domain matching user filter and navigation context.

Parameters:

filter - custom user filter

Returns:

matching domains

getDomains

List<DomainDto> getDomains(Collection<String> domainIds)

unactivateDomains

void unactivateDomains(List<String> domainIds,
                     boolean activate)

Unactivate or reactivate the given domains.

Parameters:

domainIds - domains topiaId to unactivate

getAllRefLegalStatus

List<RefLegalStatus> getAllRefLegalStatus()

Find all LegalStaus

Returns:

all LegalStaus

findRefStationMeteoByTopiaId

RefStationMeteo findRefStationMeteoByTopiaId(String topiaId)

Find the RefStationMeteo instance by a given TopiaEntity.getTopiaId().

Parameters:

topiaId - RefStationMeteo ID (TopiaEntity.getTopiaId())

Returns:

the RefStationMeteo instance

newMateriel

Equipment newMateriel()

Create new instance of domain materiel.

Returns:

new domain materiel instance

newSol

Ground newSol()

Create sol instance.

Returns:

new sol instance

extendDomain

Domain extendDomain(String domainTopiaId,
                  int extendCampaign)
                    throws DomainExtendException

Extend domain for specified campaign.

Parameters:

domainTopiaId - domain to duplicate

extendCampaign - extend domain campaign

Returns:

duplicated domain

Throws:

DomainExtendException

getRelatedDomains

LinkedHashMap<Integer,String> getRelatedDomains(String domainCode)

Get domain related to current domain. Related domain got same duplication code.

Parameters:

domainCode - the code identifying the domain

Returns:

related domains

newToolsCoupling

ToolsCoupling newToolsCoupling()

Create ToolsCoupling instance.

Returns:

new ToolsCoupling instance

getGeoPoints

List<GeoPoint> getGeoPoints(String domainId)

return GeoPoint for domain with id the given domainId Data are anonymize if user has no right to see them

Parameters:

domainId - domain'id

Returns:

all geopoints for the given domainId

getEquipments

List<Equipment> getEquipments(String domainId)

Parameters:

domainId - domain'id

Returns:

All equipements for domain with id the given domainId

getGrounds

List<Ground> getGrounds(String domainId)

Parameters:

domainId - domain'id

Returns:

All Ground for domain with id the given domainId

getToolsCouplings

List<ToolsCoupling> getToolsCouplings(String domainId)

Parameters:

domainId - domain'id

Returns:

All ToolsCoupling for domain with id the given domainId

getToolsCouplingAndUsage

UsageList<ToolsCoupling> getToolsCouplingAndUsage(String domainId)

The tools coupling UsageList from domain with id the given domainId.

Parameters:

domainId - domain'id

Returns:

All ToolsCoupling and there usage status for domain with id the given domainId

getCroppingPlanEntryDtoAndUsage

UsageList<CroppingPlanEntryDto> getCroppingPlanEntryDtoAndUsage(String domainId)

The CroppingPlanEntryDto UsageList from domain with id the given domainId.

Parameters:

domainId - domain'id

Returns:

All CroppingPlanEntryDto and there usage status for domain with id the given domainId

getCroppingPlanCodeForDomainsAndCampaigns

List<String> getCroppingPlanCodeForDomainsAndCampaigns(String code,
                                                     Set<Integer> campaigns)

List of CroppingPlan's Codes for domains with code the given code and for given campaigns.

Parameters:

code - domain's code

campaigns - required campaigns for domain, can not be null or empty

Returns:

list of CroppingPlan's Codes

getCroppingPlanSpeciesCodeForCropCodeAndCampaigns

List<String> getCroppingPlanSpeciesCodeForCropCodeAndCampaigns(String cropCode,
                                                             Set<Integer> campaigns)

getToolsCouplingCodeForDomainsAndCampaigns

List<String> getToolsCouplingCodeForDomainsAndCampaigns(String code,
                                                      Set<Integer> campaigns)

list of ToolsCoupling's Codes for domains with code the given code and for given campaigns.

Parameters:

code - domain's code

campaigns - required campaigns for domain, can not be null or empty

Returns:

List of ToolsCoupling's Codes

getToolsCouplingsForDomainCodeAndCampaigns

List<ToolsCoupling> getToolsCouplingsForDomainCodeAndCampaigns(String code,
                                                             Set<Integer> campaigns)

List of ToolsCouplings for domains with code the given code and for given campaigns.

Parameters:

code - domain's code

campaigns - required campaigns for domain, can not be null or empty

Returns:

List of ToolsCouplings

getCroppingPlanDtos

List<CroppingPlanEntryDto> getCroppingPlanDtos(String domainId)

Get the list of cropping plan (assolement) of the given domain containing only main crops (not intermediate). This list is read only and no element can be added to it.

Parameters:

domainId - domain's id

Returns:

All cropping plans (assolement) of the given domain containing only main crops (not intermediate).

getCroppingPlanSpeciesUsage

Map<String,Boolean> getCroppingPlanSpeciesUsage(String domainId)

All CroppingPlanSpecies Ids and there usage status

Parameters:

domainId - domain's id

Returns:

getEntryAndSpeciesFromCode

org.apache.commons.lang3.tuple.Pair<CroppingPlanEntry,Map<String,CroppingPlanSpecies>> getEntryAndSpeciesFromCode(String croppingPlanEntryCode,
                                                                                                                Set<Integer> campaignsSet)

Charge les couples cultures/especes à partir du code de l'espèce et d'un Set de campagnes

Parameters:

croppingPlanEntryCode - code de la culture

campaignsSet - liste des campagnes

Returns:

une Pair<Culture, Map<code espece, Espece>>

exportDomainAsXlsStream

InputStream exportDomainAsXlsStream(List<String> domainIds)

Export selected domains id as excel sheet.

importDomainForXlsStream

void importDomainForXlsStream(InputStream is)

Import domain from input stream

Parameters:

is - domains as InputStream

checkDomainExistence

boolean checkDomainExistence(String domainName)

Check if a domain already exists if specified name.

Parameters:

domainName - domain name to check

Returns:

true if a domain already exists with that name

getDomainsCount

long getDomainsCount(Boolean active)

Return the number of domains

Parameters:

active - optional active filter (may be null)

Returns:

The number of domains

getDomainPrices

List<Price> getDomainPrices(String domainTopiaId)

Parameters:

domainTopiaId - the domain's topiaId, can be null, if null an empty list is returned.

Returns:

the list of prices involved within the given domain or a list with default prices

deleteToolsCouplings

void deleteToolsCouplings(Collection<ToolsCoupling> toolsCouplings)

delete Tools couplings and the associated object

Parameters:

toolsCouplings -

deleteUnusedMainAction

void deleteUnusedMainAction(String toolsCouplingCode,
                          Collection<RefInterventionAgrosystTravailEDI> originalMainsActions,
                          Collection<RefInterventionAgrosystTravailEDI> actualMainsActions)

delete related object to the actions that are no more used

Parameters:

toolsCouplingCode - tools coupling code

originalMainsActions - collection of previous mains actions

actualMainsActions - collection of actuel mains actions

validateAndCommit

Domain validateAndCommit(String domainId)

Do validate the current domain state

Parameters:

domainId - the identifier of the domain to validate

Returns:

the validated domain

findSpeciesCodeByCropCodeForCampaigns

Map<String,org.apache.commons.lang3.tuple.Pair<CroppingPlanEntry,Map<String,CroppingPlanSpecies>>> findSpeciesCodeByCropCodeForCampaigns(List<String> croppingPlanEntryCodes,
                                                                                                                                       Set<Integer> campaignsSet)

getDomainCodeForGrowingSystem

String getDomainCodeForGrowingSystem(String growingSystemId)

return the domain code associated to the growing system with topiaId the growingSystemId parameters.

Parameters:

growingSystemId - The id of the growing system

Returns:

the domain related to the Growing System

getActiveWritableDomainsForDecisionRuleCreation

List<Domain> getActiveWritableDomainsForDecisionRuleCreation()

Do not use this method to get writable domains, this is only usable on DecisionRule creation ! See https://forge.codelutin.com/issues/4439#note-6

Returns:

get active writable domains for DecisionRule

findDomainIdsForCodeAndCampaigns

List<String> findDomainIdsForCodeAndCampaigns(String code,
                                            Set<Integer> campaigns,
                                            boolean includeCropsFromInactiveDomains)

return all domains TopiaId that match the domain code given as parameter for the given campaigns range.

Parameters:

code - the domains code

campaigns - the required campaigns

Returns:

all domains TopiaId

copyTools

List<String> copyTools(String fromDomain,
                     List<String> toDomains,
                     Boolean includeToolCouplings,
                     List<Equipment> equipmentsToCopy,
                     List<ToolsCoupling> toolsCouplingsToCopy)

Copy equipments and optionally tools couplings and manuals interventions from domain the given fromDomain to domain the given toDomains list

Parameters:

fromDomain - source domain Id

toDomains - target domains Ids

includeToolCouplings - true if tools coupling have to be include

equipmentsToCopy - list of source domain equipments

toolsCouplingsToCopy - list of tools couplings

Returns:

the result message

getDomainSAUArea

double getDomainSAUArea(String domainId)

Get domain'plots total area.

Parameters:

domainId - domain id

Returns:

total area

importPZ0Domains

void importPZ0Domains(Map<Class,ImportResults> allResult)

Try to Import domains created from from PZ0 csv

Parameters:

allResult - All domains and there dependencies required to save it.