Package com.avoka.fc.core.entity

Class SchemaSeed

java.lang.Object

org.apache.cayenne.PersistentObject

org.apache.cayenne.BaseDataObject

org.apache.cayenne.CayenneDataObject

com.avoka.core.entity.BaseEntity

com.avoka.fc.core.entity.auto._SchemaSeed

com.avoka.fc.core.entity.SchemaSeed

All Implemented Interfaces:

IEntity, Auditable, Serializable, org.apache.cayenne.DataObject, org.apache.cayenne.Persistent, org.apache.cayenne.Validating

@CacheGroups("CONFIG")
public class SchemaSeed
extends _SchemaSeed
implements Auditable

Provides an entity containing a blank seed file for a form, as well as configuration such as prefill mappings.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_XPATH_ABANDONMENT_REASON	The XPath used for the default "AbandonmentReason" configuration mapping
static final String	DEFAULT_XPATH_ATTACHMENTS	The XPath used for the default "Attachments" configuration mapping
static final String	DEFAULT_XPATH_PAYMENT_DETAILS	The XPath used for the default "Payment Details" configuration mapping
static final String	DEFAULT_XPATH_RECEIPT	The XPath used for the default "Receipt" configuration mapping
static final String	DEFAULT_XPATH_SIGNATURES	The XPath used for the default "Signatures" configuration mapping

Fields inherited from class com.avoka.fc.core.entity.auto._SchemaSeed

ABANDONMENT_REASON_XPATH, ABANDONMENT_REASON_XPATH_PROPERTY, ATTACHMENTS_XPATH, ATTACHMENTS_XPATH_PROPERTY, CONTACT_AGE_XPATH, CONTACT_AGE_XPATH_PROPERTY, CONTACT_EMAIL_XPATH, CONTACT_EMAIL_XPATH_PROPERTY, CONTACT_GENDER_XPATH, CONTACT_GENDER_XPATH_PROPERTY, CONTACT_PHONE_XPATH, CONTACT_PHONE_XPATH_PROPERTY, CONTACT_POSTCODE_XPATH, CONTACT_POSTCODE_XPATH_PROPERTY, EXTRACT_MAPS, EXTRACT_MAPS_PROPERTY, FILE_DATA, FILE_DATA_MD5, FILE_DATA_MD5_PROPERTY, FILE_DATA_PROPERTY, FILE_NAME, FILE_NAME_PROPERTY, PAYMENT_DETAILS_XPATH, PAYMENT_DETAILS_XPATH_PROPERTY, PREFILL_CLIENT_PROPERTIES_FLAG, PREFILL_CLIENT_PROPERTIES_FLAG_PROPERTY, PREFILL_PARAM_XPATHS, PREFILL_PARAM_XPATHS_PROPERTY, PROPERTY_PREFILL_MAPS, PROPERTY_PREFILL_MAPS_PROPERTY, RECEIPT_XPATH, RECEIPT_XPATH_PROPERTY, SAVE_CHALLENGE_XPATH, SAVE_CHALLENGE_XPATH_PROPERTY, SCHEMA_OID_PK_COLUMN, TRANS_REF_NUMBER_XPATH, TRANS_REF_NUMBER_XPATH_PROPERTY, TRANSACTION_VALUE_XPATH, TRANSACTION_VALUE_XPATH_PROPERTY, UPDATE_USER_PROFILE_FLAG, UPDATE_USER_PROFILE_FLAG_PROPERTY, USE_DEFAULT_CONFIG_MAPPING, USE_DEFAULT_CONFIG_MAPPING_PROPERTY, VERSION, VERSION_PROPERTY, XML_INPUT_MAPS, XML_INPUT_MAPS_PROPERTY

Fields inherited from class com.avoka.core.entity.BaseEntity

ID_PROPERTY

Fields inherited from class org.apache.cayenne.CayenneDataObject

values

Fields inherited from class org.apache.cayenne.BaseDataObject

snapshotVersion

Fields inherited from class org.apache.cayenne.PersistentObject

objectContext, objectId, persistenceState

Fields inherited from interface org.apache.cayenne.DataObject

DEFAULT_VERSION

Constructor Summary

Constructors

Constructor	Description
SchemaSeed()

Method Summary

Modifier and Type	Method	Description
Set<String>	getExtractNames()	Return the set of schema extract names.
Document	getSeedDocument()	Return the schema seed XML Document.
String	getSeedFileData()	Return the seed file data for this schema object
boolean	hasXPath(String xpath)	Return true if the SchemaSeed Form XML data has an element matching the given xpath.

Methods inherited from class com.avoka.fc.core.entity.auto._SchemaSeed

addToExtractMaps, addToPrefillParamXpaths, addToPropertyPrefillMaps, addToXmlInputMaps, getAbandonmentReasonXpath, getAttachmentsXpath, getContactAgeXpath, getContactEmailXpath, getContactGenderXpath, getContactPhoneXpath, getContactPostcodeXpath, getExtractMaps, getFileData, getFileDataMd5, getFileName, getPaymentDetailsXpath, getPrefillParamXpaths, getPropertyPrefillMaps, getReceiptXpath, getSaveChallengeXpath, getTransactionValueXpath, getTransRefNumberXpath, getVersion, getXmlInputMaps, isPrefillClientPropertiesFlag, isUpdateUserProfileFlag, isUseDefaultConfigMapping, removeFromExtractMaps, removeFromPrefillParamXpaths, removeFromPropertyPrefillMaps, removeFromXmlInputMaps, setAbandonmentReasonXpath, setAttachmentsXpath, setContactAgeXpath, setContactEmailXpath, setContactGenderXpath, setContactPhoneXpath, setContactPostcodeXpath, setFileData, setFileDataMd5, setFileName, setPaymentDetailsXpath, setPrefillClientPropertiesFlag, setReceiptXpath, setSaveChallengeXpath, setTransactionValueXpath, setTransRefNumberXpath, setUpdateUserProfileFlag, setUseDefaultConfigMapping, setVersion

Methods inherited from class com.avoka.core.entity.BaseEntity

appendProperties, getId, getValuesMap, isNew, setId, toString

Methods inherited from class org.apache.cayenne.CayenneDataObject

makePath, readPropertyDirectly, readState, setPersistenceState, writePropertyDirectly, writeState

Methods inherited from class org.apache.cayenne.BaseDataObject

addToManyTarget, beforePropertyRead, beforePropertyWrite, getSnapshotVersion, readNestedProperty, readProperty, readSerialized, removeToManyTarget, setObjectContext, setReverseRelationship, setSnapshotVersion, setToManyTarget, setToOneTarget, toStringBuffer, unsetReverseRelationship, validateForDelete, validateForInsert, validateForSave, validateForUpdate, willConnect, writeProperty, writeSerialized

Methods inherited from class org.apache.cayenne.PersistentObject

getMapKey, getObjectContext, getObjectId, getPersistenceState, setObjectId

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.avoka.fc.core.entity.Auditable

getId, getValuesMap

Methods inherited from interface org.apache.cayenne.Persistent

getObjectContext, getObjectId, getPersistenceState, setObjectContext, setObjectId, setPersistenceState

Field Details

DEFAULT_XPATH_ABANDONMENT_REASON

public static final String DEFAULT_XPATH_ABANDONMENT_REASON

The XPath used for the default "AbandonmentReason" configuration mapping

See Also:

• Constant Field Values

DEFAULT_XPATH_ATTACHMENTS

public static final String DEFAULT_XPATH_ATTACHMENTS

The XPath used for the default "Attachments" configuration mapping

See Also:

• Constant Field Values

DEFAULT_XPATH_PAYMENT_DETAILS

public static final String DEFAULT_XPATH_PAYMENT_DETAILS

The XPath used for the default "Payment Details" configuration mapping

See Also:

• Constant Field Values

DEFAULT_XPATH_RECEIPT

public static final String DEFAULT_XPATH_RECEIPT

The XPath used for the default "Receipt" configuration mapping

See Also:

• Constant Field Values

DEFAULT_XPATH_SIGNATURES

public static final String DEFAULT_XPATH_SIGNATURES

The XPath used for the default "Signatures" configuration mapping

See Also:

• Constant Field Values

Constructor Details

SchemaSeed

public SchemaSeed()

Method Details

getSeedFileData

public String getSeedFileData()

Return the seed file data for this schema object

Returns:

the seed file data

hasXPath

public boolean hasXPath(String xpath)

Return true if the SchemaSeed Form XML data has an element matching the given xpath.

Parameters:

xpath - the element xpath (required)

Returns:

true if the SchemaSeed Form XML data has an element matching the given xpath.

getSeedDocument

public Document getSeedDocument()

Return the schema seed XML Document.

Returns:

the schema seed XML Document

getExtractNames

public Set<String> getExtractNames()

Return the set of schema extract names.

Returns:

the set of schema extract names

Since:

4.0.0