Package com.avoka.fc.core.entity

Class ClientRefData

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._ClientRefData

com.avoka.fc.core.entity.ClientRefData

All Implemented Interfaces:

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

public class ClientRefData
extends _ClientRefData

The ClientRefData entity.

Since:

17.10.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATA_TYPE_CSV	The data type for CSV
static final String	DATA_TYPE_JSON	The data type for JSON
static final String	DATA_TYPE_XML	The data type for XML
static final String	FILE_NAME_DEFAULT	The default file name that will be used if the entity does not specify a file name.
static final List<String>	VALID_DATA_TYPES	The list of valid reference data types.

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

CACHE_TIMEOUT, CACHE_TIMEOUT_PROPERTY, CLIENT, CLIENT_PROPERTY, CLIENT_REF_DATA_DATA, CLIENT_REF_DATA_DATA_PROPERTY, CLIENT_REF_DATA_OID_PK_COLUMN, CREATED_AT, CREATED_AT_PROPERTY, CREATED_BY, CREATED_BY_PROPERTY, DATA_FILE_NAME, DATA_FILE_NAME_PROPERTY, DATA_HASH, DATA_HASH_PROPERTY, DATA_SIZE, DATA_SIZE_PROPERTY, DATA_TYPE, DATA_TYPE_PROPERTY, LAST_MODIFIED_AT, LAST_MODIFIED_AT_PROPERTY, LAST_MODIFIED_BY, LAST_MODIFIED_BY_PROPERTY, LOCALE, LOCALE_PROPERTY, NAME, NAME_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
ClientRefData()

Method Summary

Modifier and Type	Method	Description
String	getDataFileNameNotNull()	Return the data file name, falling back to FILE_NAME_DEFAULT and a suitable extension if the file name is blank
boolean	isTypeCSV()	return true if the type is CSV, otherwise false
boolean	isTypeJSON()	return true if the type is JSON, otherwise false
boolean	isTypeXML()	return true if the type is XML, otherwise false

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

getCacheTimeout, getClient, getClientRefDataData, getCreatedAt, getCreatedBy, getDataFileName, getDataHash, getDataSize, getDataType, getLastModifiedAt, getLastModifiedBy, getLocale, getName, setCacheTimeout, setClient, setClientRefDataData, setCreatedAt, setCreatedBy, setDataFileName, setDataHash, setDataSize, setDataType, setLastModifiedAt, setLastModifiedBy, setLocale, setName

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 org.apache.cayenne.Persistent

getObjectContext, getObjectId, getPersistenceState, setObjectContext, setObjectId, setPersistenceState

Field Details

DATA_TYPE_CSV

public static final String DATA_TYPE_CSV

The data type for CSV

See Also:

• Constant Field Values

DATA_TYPE_JSON

public static final String DATA_TYPE_JSON

The data type for JSON

See Also:

• Constant Field Values

DATA_TYPE_XML

public static final String DATA_TYPE_XML

The data type for XML

See Also:

• Constant Field Values

VALID_DATA_TYPES

public static final List<String> VALID_DATA_TYPES

The list of valid reference data types.

FILE_NAME_DEFAULT

public static final String FILE_NAME_DEFAULT

The default file name that will be used if the entity does not specify a file name. Will be augmented with an extension based on data type

See Also:

• Constant Field Values

Constructor Details

ClientRefData

public ClientRefData()

Method Details

isTypeCSV

public boolean isTypeCSV()

return true if the type is CSV, otherwise false

Returns:

return true if the type is CSV, otherwise false

isTypeJSON

public boolean isTypeJSON()

return true if the type is JSON, otherwise false

Returns:

return true if the type is JSON, otherwise false

isTypeXML

public boolean isTypeXML()

return true if the type is XML, otherwise false

Returns:

return true if the type is XML, otherwise false

getDataFileNameNotNull

public String getDataFileNameNotNull()

Return the data file name, falling back to FILE_NAME_DEFAULT and a suitable extension if the file name is blank

Returns:

the data file name, or a default file name if the data file name is null

Since:

19.11.0