Package overit.geocall.da

Class DAO

java.lang.Object
overit.geocall.da.DAO
All Implemented Interfaces:
Serializable, DataAttributesHolder, EDMConfigurableBean, overit.geocall.marks.FieldExposer, overit.geocall.marks.NameExposer, DBFieldMapper, DBObjectMapper, Tool
Direct Known Subclasses:
DAO, DAOAccessoryData, DAOAccount, DAOAccountContact, DAOAccountContactHistory, DAOAccountedSerializedMaterial, DAOAccountHistory, DAOAccountStatus, DAOAccountType, DAOActivity, DAOActivity, DAOActivityForecastHeader, DAOActivitySkillConfiguration, DAOActivitySkillConfiguration, DAOActivityToCancel, DAOAddress, DAOAddress, DAOAddressHistory, DAOAddressHistory, DAOAddressType, DAOAddressType, DAOAgenda, DAOAgenda, DAOAgendaAffinityAccountingsExtractor, DAOAgendaAffinityPrediction, DAOAgendaAffinityWorkshiftsForPrediction, DAOAgendaHistory, DAOAgendaHistory, DAOAgendaMaterial, DAOAgendaResource, DAOAgendaResourceRoles, DAOAgendaTeamResource, DAOAIAgendaAffinity, DAOAIConfigurationParams, DAOAIConfigurationParamsOpCenters, DAOAIDataExtraction, DAOAIMeterPrediction, DAOAIProcessExecutionHistory, DAOAllUsers, DAOApiKey, DAOAppointment, DAOAppointment, DAOAppointments, DAOAsset, DAOAssetCharacteristicValue, DAOAssetCharacteristicValueHistory, DAOAssetContact, DAOAssetContactHistory, DAOAssetHistory, DAOAssetOperationCenter, DAOAssetStatus, DAOAssetStatusType, DAOAssetType, DAOAssetTypeAdmittedStatus, DAOAssetTypeOperationCenter, DAOAssetTypeTemplate, DAOAssetTypeTemplateCharacteristic, overit.geocallapp.wfm.timerange.configuration.bl.da.DAOATimeRangeConfiguration, overit.geocallapp.wfm.documents.bl.attachment.data.DAOAttachment, DAOAutomaticMeterReadingMonitor, DAOAutomaticMeterReadingPredictions, DAOAutomaticMeterReadingPredictionsSearch, DAOAutomaticMeterReadingSearch, DAOAutomatonState, DAOAvailabilityType, DAOAziende, DAOBundleCriterion, DAOBundleExtractRequirements, DAOBundleHeader, DAOBundleOperation, DAOBundleRequirement, DAOBundleScheduling, DAOBundleSkill, DAOBundleSkillDivision, DAOBundlingRuleFilter, DAOBundlingRuleHeader, DAOBundlingRuleOrdering, DAOCalendarUnit, DAOCancellationActivityStatus, DAOCancelSuspendReason, DAOCancelSuspendReason, DAOCapacityPlanningResult, DAOCapacityPlanningResultDetail, DAOCapacityPlanningScenario, DAOCapacityPlanningState, DAOCatalogCode, DAOCatalogGroup, DAOCatalogGroupType, DAOCensusRule, DAOCensusType, DAOCharacteristic, DAOCharacteristicClass, DAOCheckUser, DAOClocking, DAOClocking, DAOClockingState, DAOClockingType, DAOClockingType, DAOConfParamsHistory, DAOContact, DAOContactHistory, DAOConverterType, DAOConverterType, DAOCrewShell, DAOCrewShellAddress, DAOCrewShellComposition, DAOCrewShellCompositionMismatch, DAOCrewShellConfiguration, DAOCrewShellDraftComposition, DAOCrewShellOperationCenter, DAOCrewShellSkill, DAOCrewShellType, DAOCrewShellWorkShift, DAOCriticalActivity, DAOCriticalActivityDetectProcess, DAOCriticalActivityRuleHeader, DAOCriticalActivityRuleWOFilter, DAOCustomers, DAODailyPlanOrderConfigurationDetail, DAODailyPlanOrderConfigurationHeader, DAODashboardAMRPrediction, DAODataCollectionOptionsGroup, DAODataCollectionOutcomeReasonConversion, DAODataCollectionSheet, DAODataCollectionSheetConversion, DAODataCollectionSheetConversionSubset, DAODataCollectionSheetScope, DAODataCollectionSheetState, DAODataCollectionTableNodeConversion, DAODataCollectionTemplateConversion, DAODataCollectionTemplateConversionSubset, DAODataCollectionTemplateHeader, DAODataCollectionTemplateStructure, DAODataCollectionTemplateStructureOutcomeRule, DAODataCollectionTemplateStructureRelease, DAODataCollectionTemplateTypeConversion, DAODataCollectionTemplateVersionConversion, DAODataCollectionTemplateWOCreationRule, DAODataCollectionType, DAODataCollectionWorkCycleConversion, DAODCTemplateVisibilityRuleHeader, DAODCTemplateVisibilityRuleRow, DAOElaborationHistory, DAOEncodedNote, DAOEncodedNote, DAOEventEntity, DAOEventManagerConfWoType, DAOEventType, DAOExpectedMaterialSearch, DAOExternalSystem, DAOExternalSystem, DAOFeature, DAOFeatureClass, DAOFeatureFacilityType, DAOFeatureValueDomain, DAOFeatureValueDomainItem, DAOForecastActivity, DAOForecastActivityDetail, DAOForecastActivityImportFilter, DAOForecastActivityPriority, DAOForecastActivitySkill, DAOForecastGroupingConstraint, DAOForecastResource, DAOForecastResourceDetail, DAOForecastResourceGroupingConstraint, DAOForecastResourceSkill, DAOForecastShiftModel, DAOForecastShiftModelDetail, DAOForecastState, DAOFormationSkillConfiguration, DAOFormationSkillDivision, DAOGisFileType, DAOGisLayerType, DAOGisOfflinePackage, DAOGisVisibilityRule, DAOGoodsGroup, DAOGoodsGroup, DAOHoliday, DAOHourType, DAOImmediateSchedulingCalendar, DAOImmediateSchedulingConfiguration, DAOImmediateSchedulingExclusionReason, DAOImmediateSchedulingLastProcessing, DAOImmediateSchedulingPositionType, DAOImmediateSchedulingProcessing, DAOImmediateSchedulingReprocessingMode, DAOImmediateSchedulingResourceExclusion, DAOImmediateSchedulingResourceProcessing, DAOImmediateSchedulingState, DAOImmediateSchedulingTracking, DAOImmediateSchedulingWorkOrder, DAOImmediateSchedulingWorkOrderHistory, DAOImmediateSchedulingWOSort, DAOImmediateSchedulingWOState, DAOImportExportState, DAOImportExportState, DAOIntegrationVehicleType, DAOIntervention, DAOInterventionGroup, DAOInterventionGroupCensusRule, DAOInterventionInfo, DAOInterventionOutcome, DAOInterventionPlanning, DAOInterventionResource, DAOInterventionResource, DAOLoadAllUsers, DAOLogDetail, DAOLogDetail, DAOLogMaster, DAOLogMaster, DAOMaterial, DAOMaterial, DAOMaterialAccountingType, DAOMaterialClass, DAOMaterialClass, DAOMaterialExpectedQuantity, DAOMaterialHistory, DAOMaterialHistory, DAOMaterialItem, DAOMaterialItemType, DAOMaterialManagementType, DAOMaterialManagementType, DAOMaterialType, DAOMaterialType, DAOMeasure, DAOMeasureElementTemplate, DAOMeasureHistory, DAOMeasureUnit, DAOMeasureUnit, DAOMeasuringElement, DAOMediaFile, DAOMessage, DAOMeter, DAOMeter, DAOMeterAccessibility, DAOMeterBrand, DAOMeterBrand, DAOMeterClass, DAOMeterClass, DAOMeterConverter, DAOMeterConverterHistory, DAOMeterHistory, DAOMeterHistory, DAOMeterLocation, DAOMeterLocation, DAOMeterReading, DAOMeterReadings, DAOMeterReadingsMeasure, DAOMeterReadingsTemplate, DAOMeterType, DAOMeterType, DAOMicrocluster, DAOMicroclusterAggregate, DAOMicroclusterZone, DAOMobileErrorLog, DAOMobileMultistageGroup, DAOMobileMultistageGroupOperation, DAOMobileMultistageGroupOperationDependentOperation, DAOMobileWorkOrderCreationRequestHeader, DAOMobileWorkOrderCreationRequestOperation, DAOMobileWorkOrderCreationRequestState, DAOModel, DAOModelHistory, DAOMultistageConfiguration, DAOMultistageDependencyType, DAOMultistageGroupDependency, DAOMultistageGroupHeader, DAOMultistageGroupHeaderSequenceNumber, DAOMultistageGroupOperation, DAOMultistageManagement, DAOMultistageOriginType, DAOMultistageState, DAOMultistageViolationHeader, DAOMultistageViolationMessage, DAOMultistageViolationType, DAOMunicipality, DAOMunicipality, DAONotifiableUserSearch, DAOOCGroup, DAOOnCallShift, DAOOperationActivity, DAOOperationCenter, DAOOperationCenter, DAOOperationCenterAddress, DAOOperationCenterAddress, DAOOperationCenterSchedulingConfiguration, DAOOperationCenterWorkCenter, DAOOperationExtractRequirements, DAOOperationRequirement, DAOOperationsSlots, DAOOperationType, DAOOssIntegrationConfiguration, DAOOssIntegrationType, DAOOssMatrix, DAOOssResponseLog, DAOOssResponseLogLevel, DAOOssResponseLogSearch, DAOOssResponseType, DAOOssSpace, DAOOssVehicle, DAOOssVehicle, DAOOssVehicleNoFactory, DAOOutcomeClass, DAOOutcomeReason, DAOOutcomeReason, DAOOutcomeReasonEncodedNote, DAOOutcomeReasonEncodedNote, DAOOutcomeReasonType, DAOOutcomeReasonType, DAOOutcomeType, DAOOutcomeType, DAOOutcomeWorkOrderOrigin, DAOPermitObtained, DAOPermitObtainedHistory, DAOPermitRequired, DAOPermitRequiredHistory, DAOPermitType, DAOPermitTypeOutcomeReasonRel, DAOPlannedIntervention, DAOPlanningActionHistory, DAOPPartsManagement, DAOPPartsManagementOrdersExtractor, DAOPPartsManagementPrediction, DAOPPMSearchMaterials, DAOPredictionExtractor, DAOPredictionValidationRules, DAOProfile, DAOProfiles, DAOProfileState, DAOProject, DAOProjectActivity, DAOProjectActivityDebriefing, DAOProjectActivityHistory, DAOProjectActivityRelation, DAOProjectActivityRelationType, DAOProjectActivityStartDate, DAOProjectActivityType, DAOProjectActivityUserStatus, DAOProjectDiary, DAOProjectDiaryCategory, DAOProjectDiaryHistory, DAOProjectHeaderTechnicalObjects, DAOProjectHistory, DAOProjectOperations, DAOProjectOperationsSlots, DAOProjectProfile, DAOProjectProgressive, DAOProjectType, DAOProjectUserStatus, DAOQualification, DAOReceipt, DAOReceiptType, DAORequestType, DAORequestType, DAOResource, DAOResource, DAOResourceAddress, DAOResourceAddress, DAOResourceForecastHeader, DAOResourceGPSPosition, DAOResourceLastGPSPosition, DAOResourceLoan, DAOResourceManagement, DAOResourceQualification, DAOResourceRole, DAOResourceShiftAgendaAffinity, DAOResourceShiftExceptionRequest, DAOResourceShiftExceptionRequestType, DAOResourceSkill, DAOResourceSkill, DAOResourceType, DAORole, DAORoughPlanning, DAORoughPlanningActivityResult, DAORoughPlanningBucket, DAORoughPlanningBucketMovement, DAORoughPlanningCreationFilter, DAORoughPlanningOrderMovement, DAORoughPlanningResource, DAORoughPlanningResourceResult, DAORoughPlanningState, DAORUserTypesWOStatus, DAOScheduling, DAOScheduling, DAOSchedulingArea, DAOSchedulingAreaMicrocluster, DAOSchedulingModel, DAOSchedulingModelRow, DAOSchedulingProposal, DAOSchedulingResourceType, DAOSchedulingSlotSearch, DAOSchedulingTimeslot, DAOSchedulingToCancel, DAOSchedulingUser, DAOSearchMCAggregate, DAOSearchTeamSuggestionOperationsAffinity, DAOSearchWOOperations, DAOSearchWOTypes, DAOSecret, DAOSecretValue, DAOSerializedMaterial, DAOSerializedMaterialHistory, DAOSerializedMaterialModel, DAOServiceType, DAOServiceType, overit.geocall.basic.ms.auth.DAOSession, DAOSharedResource, DAOSharedResourceMetadata, DAOSharedResourceOrigin, DAOSharedResourceType, DAOSharedResourceWithLog, DAOSharedResourceWithLog, DAOShiftExceptionClass, DAOShiftExceptionClassType, DAOShiftExceptionImpact, DAOShiftExceptionManagement, DAOSkill, DAOSkill, DAOSkillConfiguration, DAOSkillConfigurationDivision, DAOSkillConfigurationDivisionHistory, DAOSkillConfigurationHistory, DAOSkillConfigurationSkill, DAOSkillConfigurationSkillHistory, DAOSkillDivision, DAOSkillDivisionHistory, DAOSkillDivisionSkill, DAOSkillDivisionSkillHistory, DAOSkillOverrideConfiguration, DAOSkillOverrideConfigurationSkill, DAOSkillQualification, DAOSkillsExtractor, DAOStock, DAOStockChange, DAOStockHistory, DAOStockSerializedMaterial, DAOStockSerializedMaterialDetail, DAOStockType, DAOStructure, DAOStructure, DAOStructureValidityPeriod, DAOStructureValidityPeriod, DAOSurveySearch, DAOSV, DAOSystemSettings, DAOSystemUsers, DAOTask, DAOTaskCategory, DAOTaskCategoryEventType, DAOTaskHistory, DAOTaskState, DAOTeam, DAOTeamAffinity, DAOTeamDislocation, DAOTeamExperience, DAOTeamLevel, DAOTeamLocation, DAOTeamMember, DAOTeamModel, DAOTeamShift, DAOTeamShift, DAOTeamShiftResource, DAOTeamShiftResource, DAOTeamSuggestionAccountingsExtractor, DAOTeamSuggestionMonitor, DAOTeamSuggestionResourceExtractor, DAOTeamType, DAOTechnicalObject, DAOTechnicalObjectAdmittedState, DAOTechnicalObjectFeatureValue, DAOTechnicalObjectFeatureValueHistory, DAOTechnicalObjectHistory, DAOTechnicalObjectState, DAOTechnicalObjectType, DAOTechnicalObjectType, DAOTechnicalObjectTypeTemplate, DAOTimePredictionSupportFields, DAOTimesheetHeader, DAOTimesheetHeaderHistory, DAOTimesheetState, DAOTimesheetType, DAOTooltipConfiguration, DAOTooltipConfigurationRule, DAOTransferRequestHeader, DAOTransferRequestItem, DAOTransferRequestItemSerializedMaterial, DAOTransferRequestState, DAOTransferRequestType, DAOUnavailabilityMovement, DAOUser, DAOUserAdditionalTypes, DAOUserChanges, DAOUsers, DAOUserType, DAOUserType, DAOUserTypeFunction, DAOUserTypeFunctions, DAOUserTypes, DAOUserTypesFactoryUnbounded, DAOUserTypesUsers, DAOValueDomain, DAOValueDomainItem, DAOVCAppointment, DAOVehicle, DAOWarehouse, DAOWarehouseAgendaMaterial, DAOWarehouseAgendaSerializedMaterial, DAOWarehouseCentralMobile, DAOWarehouseCentralMobile, DAOWarehouseMaterial, DAOWarehouseMaterialStockSearch, DAOWarehouseOperationCenter, DAOWarehouseOperationHeader, DAOWarehouseOperationHeaderSource, DAOWarehouseOperationHeaderState, DAOWarehouseOperationItem, DAOWarehouseOperationItemSerializedMaterial, DAOWarehouseOperationItemState, DAOWarehouseOperationType, DAOWarehouseState, DAOWarehouseTrackingMode, DAOWarehouseTransaction, DAOWarehouseTransactionSerializedMaterial, DAOWarehouseTransactionType, DAOWarehouseType, DAOWarning, DAOWarningType, DAOWOResourceTimePrediction, DAOWorkCenter, DAOWorkCenter, DAOWorkCycle, DAOWorkCycleHeader, DAOWorkCycleOperation, DAOWorkCyclePermitTypeRel, DAOWorkCycleRule, DAOWorkCycleStructure, DAOWorkCycleStructurePermitTypeRel, DAOWorkDayClosureCrewShell, DAOWorkDayClosureOnFieldAgenda, DAOWorkDayClosureScheduledAgenda, DAOWorkDayClosureUsers, DAOWorkingTeam, DAOWorkLoadDistribution, DAOWorkLoadDistribution, DAOWorkOrderEncodedNote, DAOWorkOrderHeader, DAOWorkOrderHeader, DAOWorkOrderHeaderHistory, DAOWorkOrderInterventionPlanningSearch, DAOWorkOrderMeter, DAOWorkOrderNote, DAOWorkOrderObjectsExtractor, DAOWorkOrderOperation, DAOWorkOrderOperation, DAOWorkOrderOperationAccountedMaterial, DAOWorkOrderOperationHistory, DAOWorkOrderOperationMaterial, DAOWorkOrderOperationResource, DAOWorkOrderOperationState, DAOWorkOrderOperationStatus, DAOWorkOrderOperationType, DAOWorkOrderOperationType, DAOWorkOrderOperationTypeActivity, DAOWorkOrderOperationTypeActivity, DAOWorkOrderOperationTypeCategory, DAOWorkOrderSequenceNumber, DAOWorkOrderSource, DAOWorkOrderState, DAOWorkOrderStatus, DAOWorkOrderStatusUserType, DAOWorkOrderTeamAffinity, DAOWorkOrderType, DAOWorkOrderType, DAOWorkOrderTypeStructure, DAOWorkOrderUrgency, DAOWorkOrderUrgency, DAOWorkShift, DAOWorkShift, DAOWorkShift, DAOWorkShiftException, DAOWorkShiftException, DAOWorkShiftExceptionClass, DAOWorkShiftExceptionClassType, DAOWorkShiftExceptionImpact, DAOWorkShiftExceptionManagement, DAOWorkShiftExceptionType, DAOWorkShiftExceptionWorkShift, DAOWorkShiftType, DAOWorkShiftType, DAOWorkShiftTypeClass, DAOWOTimePrediction, DAOWOTimePredictionView, DAOWoTypeAdmittedMaterial, DAOZone, DAOZone, DAOZoneMicroclusterAggregate, ReadOnlyDAO, overit.geocallapp.wfm.core.data.ReadOnlyDAO
public class DAO extends Object implements DBFieldMapper, DBObjectMapper, overit.geocall.marks.FieldExposer, overit.geocall.marks.NameExposer, Serializable, Tool, EDMConfigurableBean
Class to extend when you want to create an object that accesses a table of the database. The goal of the class is to avoid writing SQL and going to build inferential rules that, based on the parameter map passed, can deduce the SQL code to be created. To use the class you need to extend it and using the annotation that gives the fundamental information of the table that you want to map.
This class implements some basic functions such the selection of one or all the table records or the deletion, insertion or updating of a record.
The methods that can be extended to create the desired logic are: validate(CommandContext, PoolKit) to perform a validation on the data, defineValues(CommandContext, PoolKit) to set up the values, getFilterCriterion(overit.geocall.da.CommandContext) to insert the Criteria that will build the SQL code and feedback(CommandContext, PoolKit, DBStatement) to manage the results.
See Also:

  • Field Details

    • SELECT_FILTER

      public static final Command SELECT_FILTER
      Standard Command that implements the query: SELECT * FROM TABLE WHERE ... = ?

    • SELECT_NONE

      public static final Command SELECT_NONE
      Standard Command that implements the empty query: SELECT * FROM TABLE WHERE 1 = 0

    • SELECT_PK

      public static final Command SELECT_PK
      Standard Command that implements the query: SELECT * FROM TABLE WHERE PRIMARY_KEY = ?

    • DELETE_FILTER

      public static final Command DELETE_FILTER
      Standard Command that deletes a record, using the filter passed to the CommandContext

    • DELETE_PK

      public static final Command DELETE_PK
      Standard Command that deletes a record, using the primary key field passed to the CommandContext

    • UPDATE_FILTER

      public static final Command UPDATE_FILTER
      Standard Command that updates a record, using the filter passed to the CommandContext

    • UPDATE_PK

      public static final Command UPDATE_PK
      Standard Command that updates a record, using the primary key passed to the CommandContext

    • INSERT

      public static final Command INSERT
      Standard Command that inserts a new record

    • INSERT_ATTEMPT

      public static final Command INSERT_ATTEMPT
      Standard Command that tries to insert a new record; if the insert fails, returns the value 0 and not an error

    • UPSERT

      public static final Command UPSERT
      Standard UPSERT Command: tries to make an update, if fails do an insert

    • INSATE

      @Deprecated public static final Command INSATE
      Deprecated.
      use UPSERT, INSERT or UPDATE_PK according to your needs. The correct functioning of this Command on all databases is not guaranteed (Postgres aborts the transaction if the INSERT raises a unique constraint violation, and the subsequent UPDATE will fail).
      Standard INSATE Command: tries to make an insert with the INSERT_ATTEMPT, if obtains 0 (meaning that the insert has failed) do an update

    • V_LEVEL_ENABLED

      protected static final String V_LEVEL_ENABLED
      See Also:

    • _dbfm

      protected DBFieldMap _dbfm

    • _dbom

      protected DBObjectMap _dbom

  • Constructor Details

    • DAO

      public DAO()
      Creates a new DAO instance.

  • Method Details

    • commandForName

      public final Command commandForName(String name)
      Returns the Command that corresponds to the query or command name passed as parameter
      Parameters:
      name - The string that defines the name of a query or command
      Returns:
      The instance of Command that corresponds to the string passed as parameter or null if there isn't such Command, or an exception occurs

    • getTeacher

      public Teacher getTeacher()
      Returns the Teacher used for the translations by the DAO
      Returns:
      The Teacher instance associated to the DAO

    • getDBFieldMap

      public DBFieldMap getDBFieldMap()
      Description copied from interface: DBFieldMapper
      Returns the DBFieldMap object
      Specified by:
      getDBFieldMap in interface DBFieldMapper
      Returns:
      The map used for the transformations of fields names

    • setDBFieldMap

      public void setDBFieldMap(DBFieldMap dbfm)
      Description copied from interface: DBFieldMapper
      Sets the DBFieldMap object
      Specified by:
      setDBFieldMap in interface DBFieldMapper
      Parameters:
      dbfm - The map used for the transformations of fields names

    • haveDBFieldMap

      public boolean haveDBFieldMap()
      Description copied from interface: DBFieldMapper
      Checks if there is a correct DBFieldMap object
      Specified by:
      haveDBFieldMap in interface DBFieldMapper
      Returns:
      true if there is a correct DBFieldMap, false otherwise

    • getDBObjectMap

      public DBObjectMap getDBObjectMap()
      Description copied from interface: DBObjectMapper
      Returns the DBObjectMap contained in the instance
      Specified by:
      getDBObjectMap in interface DBObjectMapper
      Returns:
      The map of objects used in this instance

    • setDBObjectMap

      public void setDBObjectMap(DBObjectMap dbom)
      Description copied from interface: DBObjectMapper
      Sets the DBObjectMap contained in the instance
      Specified by:
      setDBObjectMap in interface DBObjectMapper
      Parameters:
      dbom - The map of objects used in this instance

    • haveDBObjectMap

      public boolean haveDBObjectMap()
      Description copied from interface: DBObjectMapper
      Checks the presence of a valid DBObjectMap contained in the instance.
      Specified by:
      haveDBObjectMap in interface DBObjectMapper
      Returns:
      true if the instance contains a map of object that is not null, false otherwise

    • getFactory

      public String getFactory()
      Returns the name of the field of the table in which is stored the "factory id" value, set with the Factory annotation
      Returns:
      The string that represents the name of the field of the table in which is stored the "factory id" value, that is, the foreign key to the factories table

    • getBranch

      public String getBranch()
      Returns the name of the field of the table in which is stored the "branch id" value, set with the Branch annotation
      Returns:
      The string that represents the name of the field of the table in which is stored the "branch id" value, that is, the foreign key to the branches table

    • getPool

      public String getPool()
      Returns the name of the pool from which the specific DAO extracts the connections when they are not explicitly passed to methods.
      Returns:
      The name of the pool, as indicated in the configuration file, from which the specific DAO extracts the connections.

    • getTransaction

      public String getTransaction()
      Get the name of the transaction to be extracted from the PoolKit
      Returns:
      name of the transaction to be extracted from the PoolKit

    • getPk

      public String[] getPk()
      Returns the array that contains the primary keys of the specific table on which the DAO acts.
      Returns:
      Array that contains the names of the fields that are primary keys of the specific table

    • getSequence

      public String getSequence()
      Returns a string that represent the name of the field used as sequence for the insert commands on the table.
      Returns:
      The name of the sequence field or null if there isn't a defined sequence

    • isService

      public boolean isService()
      Returns the boolean value that determines whether connection extraction takes place from the standard pool or the service pool
      Returns:
      false for ordinary connection extraction, true for ServicePool extraction

    • isDistinct

      public boolean isDistinct(CommandContext cc)
      Returns the boolean value that determines whether the queries use the DISTINCT clause or not
      Parameters:
      cc - The CommandContext associated to the DAO
      Returns:
      true if the queries use the DISTINCT, false otherwise

    • getStar

      public String[] getStar(CommandContext cc)
      Returns the array that contains the field list for all the select queries.
      Parameters:
      cc - The CommandContext associated to the DAO
      Returns:
      The array of strings that represents the names of the columns to be extracted; the default value is the array consisting of a single element, the character *

    • getTable

      public String getTable(CommandContext cc)
      Returns the name of the table on which the specific DAO acts
      Parameters:
      cc - The CommandContext associated to the DAO
      Returns:
      The string that represents the name of the table on which the DAO want to access and operate

    • getLevel

      public String getLevel()
      Returns the name of the field of the table in which is stored the "level" value, so that the optimistic lock can be managed.
      Returns:
      The String about the name of the field of the table in which is stored the "level" value, so that the optimistic lock can be managed.

    • getEncrypt

      public String[] getEncrypt()
      Returns a String[] about the fields that need to be encrypted, so that encryption can be handled on those fields.
      Returns:
      a String[] about the fields that need to be encrypted, so that encryption can be handled on those fields.

    • isEncrypted

      public boolean isEncrypted()
      Returns true if this DAO instance requires the encryption mechanism; false otherwise.
      Returns:
      true if this DAO instance requires the encryption mechanism; false otherwise.

    • getCode

      public String getCode(CommandContext cc)
      Returns a String about the name of the field of the table containing a code capable of uniquely identifying each record (useful during the export of the system configuration).
      Parameters:
      cc - the CommandContext associated to the DAO.
      Returns:
      a String about the name of the field of the table containing a code capable of uniquely identifying each record (useful during the export of the system configuration).

    • getDataAttributes

      public List<DataAttribute> getDataAttributes()
      Description copied from interface: DataAttributesHolder
      Returns a List<DataAttribute> about the EDM data attributes.
      Specified by:
      getDataAttributes in interface DataAttributesHolder
      Returns:
      a List<DataAttribute> about the EDM data attributes.

    • setDataAttributes

      public void setDataAttributes(List<DataAttribute> dataAttributes)
      Description copied from interface: DataAttributesHolder
      Sets the provided dataAttributes.
      Specified by:
      setDataAttributes in interface DataAttributesHolder
      Parameters:
      dataAttributes - List<DataAttribute> about the EDM data attributes to be set.

    • markAsDecorated

      public void markAsDecorated()
      Description copied from interface: EDMConfigurableBean
      Mark this EDMConfigurableBean as already decorated with EDM configuration.
      Specified by:
      markAsDecorated in interface EDMConfigurableBean

    • hasNotBeenDecorated

      public boolean hasNotBeenDecorated()
      Description copied from interface: EDMConfigurableBean
      Returns true in case this EDMConfigurableBean has not been already decorated with EDM configuration; false otherwise.
      Specified by:
      hasNotBeenDecorated in interface EDMConfigurableBean
      Returns:
      true in case this EDMConfigurableBean has not been already decorated with EDM configuration; false otherwise.

    • getOrder

      public String[] getOrder(CommandContext cc)
      Returns the array that contains the names of the columns on which we want to make the sorting of the results of the queries.
      The method checks for the presence of a sort string in the CommandContext, the one returned by the CommandContext.getOrder() method; the default implementation interprets the string as a comma-separated list of field names on which you want to sort query results. The presence of the exclamation point in front of a field name defines the will to order in a descending direction with respect to that field.
      The extensions of this method can define their own grammar for the received string.
      If there is no sort string in the CommandContext, the fields are searched using the annotation Group
      Parameters:
      cc - The {CommandContext} associated to the DAO
      Returns:
      The array of strings that represents the name of the columns, and the corresponding sorting verse, used for the sorting of the results of the queries;

    • getGroup

      public String[] getGroup(CommandContext cc)
      Returns the array that contains the names of the columns on which we want to group the reults of the queries.
      Parameters:
      cc - The CommandContext associated to the DAO
      Returns:
      The array of strings that represents the name of the columns used for the grouping of the results of the queries

    • getFilterCriterion

      protected Criterion getFilterCriterion(CommandContext cc)
      Method to extend to go to introduce the inferential rules with which to deduce the SQL automatically based on the context passed as a parameter.
      Parameters:
      cc - The CommandContext associated to the DAO
      Returns:
      The Criterion used to create the SQL By default the method returns the Criteria.SEARCH_STRONG for the commands that refers to key fields and the Criteria.SEARCH for all the other commands.

    • getValuesCriterion

      protected Criterion getValuesCriterion(CommandContext cc)
      Method that defines the Criterion used for the different commands
      Parameters:
      cc - The CommandContext associated to the DAO
      Returns:
      Criteria.INSERT_ASSIGN for the Command.Type.INSERT commands, Criteria.UPDATE_ASSIGN for the Command.Type.UPDATE commands

    • execute

      public void execute(CommandContext cc) throws DAException, DAValidateException
      Executes the command; it extracts a new PooledConnection from the pool
      Parameters:
      cc - The CommandContext associated to the DAO
      Throws:
      DAException - If there is a (blocking) data-access error, a DAException must be thrown
      DAValidateException - If there are error in the validation phase, a DAValidateException must be thrown

    • execute

      public void execute(CommandContext cc, PoolKit pk) throws DAException, DAValidateException
      Executes the command
      Parameters:
      cc - The CommandContext associated to the DAO; it can't be null
      pk - The PoolKit used to connect to the database; it can't be null
      Throws:
      DAException - If there is a (blocking) data-access error, a DAException must be thrown
      DAValidateException - If there are error in the validation phase, a DAValidateException must be thrown

    • execute

      public void execute(Batch batch) throws DAException, DAValidateException
      Executes the provided Batch; it extracts a new PooledConnection from the pool.
      Parameters:
      batch - The Batch containing a list of CommandContexts associated to the DAO; it can't be null.
      Throws:
      DAException - If there is a (blocking) data-access error, a DAException must be thrown.
      DAValidateException - If there are error in the validation phase, a DAValidateException must be thrown.

    • execute

      public void execute(Batch batch, PoolKit pk) throws DAException, DAValidateException
      Executes the provided Batch.
      Parameters:
      batch - The Batch containing a list of CommandContexts associated to the DAO; it can't be null.
      pk - The PoolKit used to connect to the database; it can't be null.
      Throws:
      DAException - If there is a (blocking) data-access error, a DAException must be thrown.
      DAValidateException - If there are error in the validation phase, a DAValidateException must be thrown.

    • scan

      public void scan(CommandContext cc, PoolKit pk, DBScanner scanner) throws DAException, DAValidateException
      scans the dataset defined by a DAO Select command with a DBScanner
      Parameters:
      cc - The CommandContext associated to the DAO; it can't be null
      pk - The PoolKit used to connect to the database; it can't be null
      scanner - a DBCursor/ResultSet scanner
      Throws:
      DAException - If there is a (blocking) data-access error, a DAException must be thrown
      DAValidateException - If there are error in the validation phase, a DAValidateException must be thrown

    • query

      public DBView query(CommandContext cc) throws DAException, DAValidateException
      Executes the query defined by the CommandContext passed as parameter
      Parameters:
      cc - The CommandContext associated to the DAO;
      Returns:
      The DBView that contains the records extracted
      Throws:
      DAException - If there is a (blocking) data-access error, a DAException must be thrown
      DAValidateException - If there are error in the validation phase, a DAValidateException must be thrown

    • query

      public DBView query(CommandContext cc, PoolKit pk) throws DAException, DAValidateException
      Executes the query defined by the CommandContext passed as parameter
      Parameters:
      cc - The CommandContext associated to the DAO;
      pk - The PoolKit used to connect to the database;
      Returns:
      The DBView that contains the records extracted
      Throws:
      DAException - If there is a (blocking) data-access error, a DAException must be thrown
      DAValidateException - If there are error in the validation phase, a DAValidateException must be thrown

    • command

      public int command(CommandContext cc, PoolKit pk) throws DAException, DAValidateException
      Executes the command defined by the CommandContext passed as parameter
      Parameters:
      cc - The CommandContext associated to the DAO;
      pk - The PoolKit used to connect to the database;
      Returns:
      The number of records that have been entered, modified or deleted
      Throws:
      DAException - If there is a (blocking) data-access error, a DAException must be thrown
      DAValidateException - If there are error in the validation phase, a DAValidateException must be thrown

    • command

      public int command(CommandContext cc) throws DAException, DAValidateException
      Executes the command defined by the CommandContext passed as parameter
      Parameters:
      cc - The CommandContext associated to the DAO;
      Returns:
      The number of records that have been entered, modified or deleted
      Throws:
      DAException - If there is a (blocking) data-access error, a DAException must be thrown
      DAValidateException - If there are error in the validation phase, a DAValidateException must be thrown

    • validate

      protected void validate(CommandContext cc, PoolKit pk) throws DAException, DAValidateException
      Method to extend if you want to implement some logic of data validation; it can raise a DAException, or better, a DAValidateException. By default the method verifies that, if the command requested is a command that refers to a key field, that key field has been defined for the DAO and that the key field is among those passed as filter.
      Parameters:
      cc - The CommandContext associated to the DAO
      pk - The PoolKit from which extract the connections
      Throws:
      DAException - If there is a (blocking) data-access error, a DAException must be thrown
      DAValidateException - If there are error in the validation phase, a DAValidateException must be thrown

    • defineValues

      protected void defineValues(CommandContext cc, PoolKit pk) throws DAException, DAValidateException
      Method to extend to go to prepare the values operating Java side, for example making calculations, avoiding to operate SQL side that is much more difficult, inconvenient, difficult to maintain and not portable. Changing the values in this method can have a return in the application mask, since the same map of values is used, and not a clone of it. By default the method sets the correct values for the sequence, the datastamp and login, where necessary.
      Parameters:
      cc - The CommandContext associated to the DAO
      pk - The PoolKit from which extract the connections
      Throws:
      DAException - If there is a (blocking) data-access error, a DAException must be thrown
      DAValidateException - If there are error in the validation phase, a DAValidateException must be thrown

    • defineParams

      protected void defineParams(CommandContext cc, PoolKit pk) throws DAException, DAValidateException
      The method performs a cloning of the maps of the filters and of the values and makes a merge, putting before the filter field names the string F: and before the value field names the string V: to avoid possible conflicts; this is necessary because the same field can be used with different semantics, as a filter and as a value, for example for the UPDATE_FILTER commands
      Parameters:
      cc - The CommandContext associated to the DAO
      pk - The PoolKit from which extract the connections
      Throws:
      DAException - If there is a (blocking) data-access error, a DAException must be thrown
      DAValidateException - If there are error in the validation phase, a DAValidateException must be thrown

    • defineSql

      protected void defineSql(CommandContext cc, PoolKit pk) throws DAException, DAValidateException
      The method creates the SQL command using the language of the criteria, and in particular based on the method getFilterCriterion(overit.geocall.da.CommandContext)
      Parameters:
      cc - The CommandContext associated to the DAO
      pk - The PoolKit from which extract the connections
      Throws:
      DAException - If there is a (blocking) data-access error, a DAException must be thrown
      DAValidateException - If there are error in the validation phase, a DAValidateException must be thrown

    • defineStatement

      protected void defineStatement(CommandContext cc, PoolKit pk, DBStatement dbs) throws DAException, DAValidateException
      The method defines the DBStatement, sets the SQL and the parameters for the execution of the commands
      Parameters:
      cc - The CommandContext associated to the DAO
      pk - The PoolKit from which extract the connections
      dbs - The DBStatement that is used to access the database
      Throws:
      DAException - If there is a (blocking) data-access error, a DAException must be thrown
      DAValidateException - If there are error in the validation phase, a DAValidateException must be thrown

    • feedback

      protected void feedback(CommandContext cc, PoolKit pk, DBStatement dbs) throws DAException, DAValidateException
      Method to be extended to carry out operations exploiting the result of the executed command; for example it can be used to implement CASE WHEN logics that can therefore be deleted from the SQL. The standard makes recursive calls for the correct execution of the UPSERT and INSATE operations
      Parameters:
      cc - The CommandContext associated to the DAO
      pk - The PoolKit from which extract the connections
      dbs - The DBStatement that is used to access the database
      Throws:
      DAException - If there is a (blocking) data-access error, a DAException must be thrown
      DAValidateException - If there are error in the validation phase, a DAValidateException must be thrown