sapphire.attachment

Class Attachment

java.lang.Object

sapphire.attachment.Attachment

All Implemented Interfaces:

com.labvantage.sapphire.gwt.shared.JSONable, java.io.Serializable

public abstract class Attachment
extends java.lang.Object
implements java.io.Serializable, com.labvantage.sapphire.gwt.shared.JSONable

Class to represent an sdi attachment record including its type, file details, storage details and data. This class can then be used to feed in and out of the AttachmentProcessor methods to get, add and edit the attachment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Attachment.AttachmentType Attachment Type Enumeration Type File now includes all backwards compatiable types such as Store, Reference, Upload and Store and Upload and Reference
static class	Attachment.ThumbnailGeneration Thummail Generation Enumeration Used to determine how the system handles and generates Thumbnails

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_FORMATTEDTEXT
static java.lang.String	TYPE_LINKEDREFERENCE
static java.lang.String	TYPE_PLAINTEXT
static java.lang.String	TYPE_REFERENCE
static java.lang.String	TYPE_STORE
static java.lang.String	TYPE_UPLOADANDREFERENCE
static java.lang.String	TYPE_UPLOADANDSTORE
static java.lang.String	TYPE_URL

Fields inherited from interface com.labvantage.sapphire.gwt.shared.JSONable

TYPE_SUFFIX

Constructor Summary

Constructors

Constructor and Description
Attachment()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkHash(long hash)
protected boolean	checkHash(java.lang.String databaseId)
static java.lang.String	evaluateFileNameExpressions(java.lang.String sdcid, java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3, int attachmentnum, ConnectionInfo connectionInfo, java.lang.String input, Attachment attachment)
static java.lang.String	evaluateFileNameExpressions(java.lang.String sdcid, java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3, int attachmentnum, int auditsequence, ConnectionInfo connectionInfo, java.lang.String input, Attachment attachment)
void	generateThumbnail(java.lang.String connectionid) Will generate the thumbnail and populate the Thumbnail property of the attachment object.
java.lang.String	getAdditionalColumn(java.lang.String key, java.lang.String defaultValue) Will return the value of the column provided.
protected PropertyList	getAdditionalColumns()
protected boolean	getAllowLocalCache()
static Attachment	getAttachment(DataSet sdiAttachmentData, int sdiAttRow, java.lang.String connectionId) Used to fetch a new Attachment object based off a data set of sdiattachment records.
static Attachment	getAttachment(DataSet sdiAttachmentData, java.lang.String sdcid, java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3, int attachmentNum, java.lang.String connectionId) Get an attachment object based off attachment data
static Attachment	getAttachment(PropertyList propertyList, java.lang.String connectionId) Used to fetch a new Attachment object based off a property list provided.
static Attachment	getAttachment(java.lang.String sdcid, java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3) Used to fetch a new black attachment object which can then be fed into the Attachment Processor.
static Attachment	getAttachment(java.lang.String sdcid, java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3, int attachmentnum) Used to fetch a new black attachment object which can then be fed into the Attachment Processor.
static Attachment	getAttachment(java.lang.String sdcid, java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3, int attachmentNum, QueryProcessor queryProcessor, java.lang.String connectionId) Get an attachment object based on sdcid,keyid1, 2 and 3
java.lang.String	getAttachmentClass() Returns the attachment class
int	getAttachmentNum() Returns the attachment number
protected BaseAttachmentRepository	getAttachmentRepository(com.labvantage.sapphire.services.SapphireConnection sapphireConnection, PropertyList attachmentPolicy) Will return the Attachment Repository object based of the Attachment object.
protected BaseAttachmentRepository	getAttachmentRepository(com.labvantage.sapphire.services.SapphireConnection sapphireConnection, PropertyList attachmentPolicy, boolean defaultToCompatability) Will return the Attachment Repository object based of the Attachment object.
protected BaseAttachmentRepository	getAttachmentRepository(com.labvantage.sapphire.services.SapphireConnection sapphireConnection, PropertyList attachmentPolicy, boolean defaultToCompatability, Attachment basedOn) Will return the Attachment Repository object based of the Attachment object.
protected java.lang.String	getAttachmentRepositoryId()
protected java.lang.String	getAttachmentRepositoryNodeId()
protected com.labvantage.sapphire.attachment.AttachmentRule	getAttachmentRule()
Attachment.AttachmentType	getAttachmentType() Will return the attachment type of the attachment
java.sql.Blob	getBlob() Returns the blob value.
protected java.nio.file.Path	getCachedPath(java.lang.String databaseid, boolean explodedzip)
java.lang.String	getClob() Used to get the clob column on the attachment.
byte[]	getData() Gets the data in the attachment as a byte array.
byte[]	getData(int maxsizelimit) Gets the data in the attachment as a byte array.
protected long	getDataHash()
java.lang.String	getDescription() Returns the attachment description
java.lang.String	getFilename() Returns the file name of the attachment.
java.io.InputStream	getInputStream() Gets the input stream for adding/updating an attachment We recommend using this over getting the byte array or blob of the attachment for efficiency and memory management
java.lang.String	getKeyId1() Get the key id 1
java.lang.String	getKeyId2() Get the key id 2
java.lang.String	getKeyId3() Get the key id 3
int	getLinkAttachmentNum() Gets the Link Attachment Number if the attachment is a linked attachment created from a copy down.
java.lang.String	getLinkKeyId1() Gets the Link Key Id 1 if the attachment is a linked attachment created from a copy down.
java.lang.String	getLinkKeyId2() Gets the Link Key Id 2 if the attachment is a linked attachment created from a copy down.
java.lang.String	getLinkKeyId3() Gets the Link Key Id 3 if the attachment is a linked attachment created from a copy down.
java.lang.String	getLinkSdcid() Gets the Link SDC Id if the attachment is a linked attachment created from a copy down.
protected java.nio.file.Path	getLocalFile()
boolean	getLockAttachment() Returns true if the attachment is locked from update as part of version control.
java.lang.String	getOleClass() Gets the OLE class.
protected java.lang.String	getParentDepartment()
java.lang.String	getRepositoryId() Get the external id for the external repository.
java.lang.String	getSDCId() Get the SDC Id
protected java.lang.String	getSDIAttachmentId()
long	getSize() Gets the size of the data in the attachment
java.lang.String	getSourceFilename() Returns the source filename of the attachment.
java.lang.String	getTempId() Returns the Temporary Id for the SDI Temp record Note this is used internally when uploading an attachment prior to save on a maintenance page.
java.lang.String	getThumbnailImage() Gets the thumnail image of the attachment.
protected boolean	getTriggerBusinessRule()
java.lang.String	getType() Get the attachment type flag.
java.lang.String	getUploadTo()
java.lang.String	getUrl() Returns the URL if a URL attachment.
boolean	hasData() Returns true if the attachment has data in it and that data is available to read.
boolean	isByReference() Will return true to indicate that the file name in this attachment is a reference attachment.
boolean	isCompressed() Returns true if the attachment was compressed in storage.
boolean	isEncrypted() Returns true if the attachment was encrypted in storage.
protected boolean	isEncryptionRequired(PropertyList attachmentPolicy, ConfigurationProcessor cp) Will return back if encryption is requied based on the attachment rules
boolean	isHashed() Returns true if the data inside the attachment has been hashed Internally this returns trus if the datahash of the attachment is not 0.
boolean	isInvalidHash() Returns true if hashing failed and the attachment has an invalid has.
protected boolean	isZippingRequired(PropertyList attachmentPolicy, ConfigurationProcessor cp) Will return back if Zipping is requied based on the attachment rules
protected void	loadLocalFile(java.nio.file.Path p)
static java.lang.String	replaceDateTokens(java.lang.String filename)
static java.lang.String	replaceDbTokens(java.lang.String filename, java.lang.String sdcid, java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3, Attachment attachment, ConnectionInfo connectionInfo)
static java.lang.String	replaceInvalidChars(java.lang.String tokens, java.lang.String replacement)
protected java.nio.file.Path	saveLocalFile(boolean cache, java.lang.String databaseid, boolean checkHash, boolean generateHash, java.nio.file.Path usepath, boolean doDeleteTempFile)
protected void	setAdditionalColumn(java.lang.String key, java.lang.String value)
void	setAdditionalColumns(DataSet sdiAttachmentData, int sdiAttRow) Will set any additional columns found in the provided dataset against this attachment object.
void	setAdditionalColumns(PropertyList additionalColumns, java.lang.String connectionid) Will set any additional columns found in the provided property list against this attachment object.
protected void	setAllowLocalCache(boolean allowlocalcache)
void	setAttachment(DataSet sdiAttachmentData, int sdiAttRow) Used to set an attachment object based off a data set of sdiattachment records.
void	setAttachmentClass(java.lang.String attclass) Set the attachment class for the attachment.
protected void	setAttachmentNum(int attnum)
protected void	setAttachmentRepositoryId(java.lang.String attachmentRepositoryId)
protected void	setAttachmentRepositoryNodeId(java.lang.String attachmentRepositoryNodeId)
void	setAttachmentType(Attachment.AttachmentType attachmentType) Used to set the type of attachment.
void	setBlob(java.sql.Blob blob) Sets the blob object on the attachment.
void	setByReference(boolean byReference) Use this will a parameter value of true to indicate that the file name in this attachment is a reference attachment.
void	setClob(java.lang.String clob) Used to set the clob column on the attachment.
void	setCompressed(boolean compressedFlag) Set to true if you wish to force compression.
void	setData(byte[] data) Sets the file data for the attachment.
void	setDescription(java.lang.String description) Sets the description of the attachment.
void	setEncrypted(boolean encryptedFlag) Set to true to encrypt the attachment and force this over the rules evaluation.
void	setFilename(java.lang.String filename) Sets the filename of the attachment.
void	setInputStream(java.io.InputStream in) Sets the input stream for adding/updating a new attachment We recommend using this over setting the byte array or blob of the attachment for efficiency and memory management
protected void	setInvalidHash(boolean invalidHash)
protected void	setKeyId1(java.lang.String keyid1)
protected void	setKeyId2(java.lang.String keyid2)
protected void	setKeyId3(java.lang.String keyid3)
protected void	setLinkSDI(java.lang.String sdcid, java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3, int attachmentnum)
void	setLockAttachment(boolean lockAttachment) Set to true to lock the attachment for update from others and to allow version control.
void	setOleClass(java.lang.String oleClass) Sets the OLE class.
protected void	setParentDepartment(java.lang.String parentDepartment)
void	setRepositoryId(java.lang.String repositoryId) Set the external id for the external repository.
protected void	setSDCId(java.lang.String sdcid)
protected void	setSDIAttachmentId(java.lang.String sdiattachmentid)
void	setSize(long size)
void	setSourceFilename(java.lang.String sourcefilename) Sets the source filename of the attachment.
void	setTempId(java.lang.String tempid) Sets the temporary id for the sdi temp record.
void	setThumbnailImage(java.lang.String thumbnailimage) Sets the thumnail image of the attachment.
protected void	setTriggerBusinessRule(boolean triggerBusinessRule)
protected void	setType(java.lang.String type)
void	setUploadTo(java.lang.String uploadTo)
protected void	setUrl(java.lang.String url)
java.lang.String	toJSONString() This returns a JSON representation of the attachment object.
PropertyList	toPropertyList(boolean returnData, boolean thumbnail, boolean additionalColumns, java.lang.String connectionid) Will convert the Attachment object to a property list version where all variables become root properties and additional columns also become root properties.
void	toPropertyList(PropertyList properties, boolean returnData, boolean thumbnail, boolean returnAdditionalColumns, java.lang.String connectionid) Will convert the Attachment object to a property list version where all variables become root properties and additional columns also become root properties.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_UPLOADANDSTORE

public static final java.lang.String TYPE_UPLOADANDSTORE

See Also:

Constant Field Values

TYPE_STORE

public static final java.lang.String TYPE_STORE

See Also:

Constant Field Values

TYPE_REFERENCE

public static final java.lang.String TYPE_REFERENCE

See Also:

Constant Field Values

TYPE_UPLOADANDREFERENCE

public static final java.lang.String TYPE_UPLOADANDREFERENCE

See Also:

Constant Field Values

TYPE_URL

public static final java.lang.String TYPE_URL

See Also:

Constant Field Values

TYPE_PLAINTEXT

public static final java.lang.String TYPE_PLAINTEXT

See Also:

Constant Field Values

TYPE_LINKEDREFERENCE

public static final java.lang.String TYPE_LINKEDREFERENCE

See Also:

Constant Field Values

TYPE_FORMATTEDTEXT

public static final java.lang.String TYPE_FORMATTEDTEXT

See Also:

Constant Field Values

Constructor Detail

Attachment

public Attachment()

Method Detail

getAttachment

public static Attachment getAttachment(DataSet sdiAttachmentData,
                                       java.lang.String sdcid,
                                       java.lang.String keyid1,
                                       java.lang.String keyid2,
                                       java.lang.String keyid3,
                                       int attachmentNum,
                                       java.lang.String connectionId)

Get an attachment object based off attachment data

Parameters:

sdiAttachmentData - sdiattachment dataset

sdcid -

keyid1 -

keyid2 -

keyid3 -

attachmentNum -

connectionId -

Returns:

getAttachment

public static Attachment getAttachment(java.lang.String sdcid,
                                       java.lang.String keyid1,
                                       java.lang.String keyid2,
                                       java.lang.String keyid3,
                                       int attachmentNum,
                                       QueryProcessor queryProcessor,
                                       java.lang.String connectionId)

Get an attachment object based on sdcid,keyid1, 2 and 3

Parameters:

sdcid -

keyid1 -

keyid2 -

keyid3 -

attachmentNum -

queryProcessor -

connectionId -

Returns:

getTriggerBusinessRule

protected boolean getTriggerBusinessRule()

setParentDepartment

protected void setParentDepartment(java.lang.String parentDepartment)

getParentDepartment

protected java.lang.String getParentDepartment()

setTriggerBusinessRule

protected void setTriggerBusinessRule(boolean triggerBusinessRule)

getSDIAttachmentId

protected java.lang.String getSDIAttachmentId()

setSDIAttachmentId

protected void setSDIAttachmentId(java.lang.String sdiattachmentid)

getLocalFile

protected java.nio.file.Path getLocalFile()

getCachedPath

protected java.nio.file.Path getCachedPath(java.lang.String databaseid,
                                           boolean explodedzip)

loadLocalFile

protected void loadLocalFile(java.nio.file.Path p)

setAdditionalColumns

public void setAdditionalColumns(PropertyList additionalColumns,
                                 java.lang.String connectionid)

Will set any additional columns found in the provided property list against this attachment object. This can be used to set up additional information prior to Add or Edit sdi attachment.

Parameters:

additionalColumns - Key value pair of columns and values

connectionid - Current connection id used for file type management

setAdditionalColumns

public void setAdditionalColumns(DataSet sdiAttachmentData,
                                 int sdiAttRow)

Will set any additional columns found in the provided dataset against this attachment object. This can be used to set up additional information prior to Add or Edit sdi attachment.

Parameters:

sdiAttachmentData - - the sdiattachment table structure for the columns.

sdiAttRow - - the row to obtain values from in the sdiattachment data

getAttachmentRule

protected com.labvantage.sapphire.attachment.AttachmentRule getAttachmentRule()

setAdditionalColumn

protected void setAdditionalColumn(java.lang.String key,
                                   java.lang.String value)

getAdditionalColumns

protected PropertyList getAdditionalColumns()

setSDCId

protected void setSDCId(java.lang.String sdcid)

setKeyId1

protected void setKeyId1(java.lang.String keyid1)

setKeyId2

protected void setKeyId2(java.lang.String keyid2)

setKeyId3

protected void setKeyId3(java.lang.String keyid3)

setAttachmentNum

protected void setAttachmentNum(int attnum)

setAttachmentRepositoryId

protected void setAttachmentRepositoryId(java.lang.String attachmentRepositoryId)

setAttachmentRepositoryNodeId

protected void setAttachmentRepositoryNodeId(java.lang.String attachmentRepositoryNodeId)

getAttachmentRepositoryId

protected java.lang.String getAttachmentRepositoryId()

getAttachmentRepositoryNodeId

protected java.lang.String getAttachmentRepositoryNodeId()

setType

protected void setType(java.lang.String type)

setUploadTo

public void setUploadTo(java.lang.String uploadTo)

getUploadTo

public java.lang.String getUploadTo()

setSize

public void setSize(long size)

setLinkSDI

protected void setLinkSDI(java.lang.String sdcid,
                          java.lang.String keyid1,
                          java.lang.String keyid2,
                          java.lang.String keyid3,
                          int attachmentnum)

getDataHash

protected long getDataHash()

checkHash

protected boolean checkHash(long hash)

setInvalidHash

protected void setInvalidHash(boolean invalidHash)

saveLocalFile

protected java.nio.file.Path saveLocalFile(boolean cache,
                                           java.lang.String databaseid,
                                           boolean checkHash,
                                           boolean generateHash,
                                           java.nio.file.Path usepath,
                                           boolean doDeleteTempFile)

checkHash

protected boolean checkHash(java.lang.String databaseId)

setUrl

protected void setUrl(java.lang.String url)

getAllowLocalCache

protected boolean getAllowLocalCache()

setAllowLocalCache

protected void setAllowLocalCache(boolean allowlocalcache)

getAttachmentRepository

protected BaseAttachmentRepository getAttachmentRepository(com.labvantage.sapphire.services.SapphireConnection sapphireConnection,
                                                           PropertyList attachmentPolicy,
                                                           boolean defaultToCompatability)
                                                    throws SapphireException

Will return the Attachment Repository object based of the Attachment object. This internally will examine the Attachment object and use the Attachment Policy rules collection to identify which Repository the attachment should be using and return an instance of that Repository.

Parameters:

sapphireConnection - The SapphireConnection object

attachmentPolicy - The attachment policy property list

defaultToCompatability - Set to true to allow the rules to default to backwards compatible repositories if no repository could be identified.

Returns:

Returns an instance of the Attachment Repository

Throws:

SapphireException

getAttachmentRepository

protected BaseAttachmentRepository getAttachmentRepository(com.labvantage.sapphire.services.SapphireConnection sapphireConnection,
                                                           PropertyList attachmentPolicy,
                                                           boolean defaultToCompatability,
                                                           Attachment basedOn)
                                                    throws SapphireException

Will return the Attachment Repository object based of the Attachment object. This internally will examine the Attachment object and use the Attachment Policy rules collection to identify which Repository the attachment should be using and return an instance of that Repository.

Parameters:

sapphireConnection - The SapphireConnection object

attachmentPolicy - The attachment policy property list

defaultToCompatability - Set to true to allow the rules to default to backwards compatible repositories if no repository could be identified.

basedOn - Pass in another Attachment object to base the rule generation on.

Returns:

Returns an instance of the Attachment Repository

Throws:

SapphireException

isZippingRequired

protected boolean isZippingRequired(PropertyList attachmentPolicy,
                                    ConfigurationProcessor cp)

Will return back if Zipping is requied based on the attachment rules

Parameters:

attachmentPolicy - The Attachment policy property list

Returns:

Returns true if zipping of the attachment is required

isEncryptionRequired

protected boolean isEncryptionRequired(PropertyList attachmentPolicy,
                                       ConfigurationProcessor cp)

Will return back if encryption is requied based on the attachment rules

Parameters:

attachmentPolicy - The Attachment policy property list

Returns:

Returns true if encryption of the attachment is required

getAttachmentRepository

protected BaseAttachmentRepository getAttachmentRepository(com.labvantage.sapphire.services.SapphireConnection sapphireConnection,
                                                           PropertyList attachmentPolicy)
                                                    throws SapphireException

Will return the Attachment Repository object based of the Attachment object. This internally will examine the Attachment object and use the Attachment Policy rules collection to identify which Repository the attachment should be using and return an instance of that Repository.

Parameters:

sapphireConnection - The SapphireConnection object

attachmentPolicy - The attachment policy property list

Returns:

Returns an instance of the Attachment Repository

Throws:

SapphireException

toPropertyList

public PropertyList toPropertyList(boolean returnData,
                                   boolean thumbnail,
                                   boolean additionalColumns,
                                   java.lang.String connectionid)
                            throws SapphireException

Will convert the Attachment object to a property list version where all variables become root properties and additional columns also become root properties.

Parameters:

returnData - Set to true to return the data of the attachment. If a file then this is the base64 encoded file data

thumbnail - Set to true to return the thumbnail data

additionalColumns - Set to true to include additional columns (from collection) as root level properties

Returns:

Returns the new property list

Throws:

SapphireException

toJSONString

public java.lang.String toJSONString()

This returns a JSON representation of the attachment object. Note this method first calls toPropertyList and then converts the returning property list to JSON.

Specified by:

toJSONString in interface com.labvantage.sapphire.gwt.shared.JSONable

Returns:

Returns the String representation of the JSON object.

toPropertyList

public void toPropertyList(PropertyList properties,
                           boolean returnData,
                           boolean thumbnail,
                           boolean returnAdditionalColumns,
                           java.lang.String connectionid)
                    throws SapphireException

Will convert the Attachment object to a property list version where all variables become root properties and additional columns also become root properties.

Parameters:

properties - The property list to add the properties into.

returnData - Set to true to return the data of the attachment. If a file then this is the base64 encoded file data

thumbnail - Set to true to return the thumbnail data

returnAdditionalColumns - Set to true to include additional columns (from collection) as root level properties

Throws:

SapphireException

getAttachment

public static Attachment getAttachment(java.lang.String sdcid,
                                       java.lang.String keyid1,
                                       java.lang.String keyid2,
                                       java.lang.String keyid3)

Used to fetch a new black attachment object which can then be fed into the Attachment Processor. You will also need to populate the attachment number or attachment class (or audit number) if then using to fetch the attachment using the attachment processor.

Parameters:

sdcid - SDC Id for the attachment record

keyid1 - Key Id 1 for the attachment record

keyid2 - Key Id 2 for the attachment record

keyid3 - Key Id 3 for the attachment record

Returns:

Returns the new Attachment object. There will be no file data or additional column data and just an empty attachment object. You will then need to use getSDIAttachment on the AttachmentProcessor.

getAttachment

public static Attachment getAttachment(PropertyList propertyList,
                                       java.lang.String connectionId)

Used to fetch a new Attachment object based off a property list provided. Internally this will create an empty Attachment Object and use the setPropertyList to take the properties and populate the variables or additional columns. You can then use this new Attachment object with the AttachmentProcessor.

Parameters:

propertyList - The property list representing the attachment record.

Returns:

Returns the new Attachment object.

getAttachment

public static Attachment getAttachment(java.lang.String sdcid,
                                       java.lang.String keyid1,
                                       java.lang.String keyid2,
                                       java.lang.String keyid3,
                                       int attachmentnum)

Used to fetch a new black attachment object which can then be fed into the Attachment Processor.

Parameters:

sdcid - SDC Id for the attachment record

keyid1 - Key Id 1 for the attachment record

keyid2 - Key Id 2 for the attachment record

keyid3 - Key Id 3 for the attachment record

attachmentnum - The attachment number for the attachment record.

Returns:

Returns the new Attachment object. There will be no file data or additional column data and just an empty attachment object. You will then need to use getSDIAttachment on the AttachmentProcessor.

getAttachment

public static Attachment getAttachment(DataSet sdiAttachmentData,
                                       int sdiAttRow,
                                       java.lang.String connectionId)

Used to fetch a new Attachment object based off a data set of sdiattachment records. Internally this will create an empty Attachment Object and use the setAttachment to take the column values and populate the variables or additional columns. You can then use this new Attachment object with the AttachmentProcessor.

Parameters:

sdiAttachmentData - The dataset representing the attachment records.

sdiAttRow - The row to take from the provided dataset

Returns:

Returns the new Attachment object.

setAttachment

public void setAttachment(DataSet sdiAttachmentData,
                          int sdiAttRow)

Used to set an attachment object based off a data set of sdiattachment records. Internally this will take the column values and populate the variables or additional columns. You can then use this Attachment object with the AttachmentProcessor.

Parameters:

sdiAttachmentData - The dataset representing the attachment records.

sdiAttRow - The row to take from the provided dataset

setByReference

public void setByReference(boolean byReference)

Use this will a parameter value of true to indicate that the file name in this attachment is a reference attachment. This will internally use an unmanaged repository to store the attachment. Note that this should only be used for backwards compatibility and moving forward you should use the repository id or the attachment policy rules to determine the destination We also recommend against reference or unmanaged attachments and recommend using a managed reposiroty where versioning and security can be maintained.

Parameters:

byReference - Boolean of true or false for weather the attachment is by reference

isByReference

public boolean isByReference()

Will return true to indicate that the file name in this attachment is a reference attachment. This will internally be an unmanaged repository where the attachment is stored.

Parameters:

byReference - Boolean of true or false for weather the attachment is by reference

setAttachmentType

public void setAttachmentType(Attachment.AttachmentType attachmentType)

Used to set the type of attachment.

Parameters:

attachmentType - The type of attachment based off of the enumeration

getAttachmentType

public Attachment.AttachmentType getAttachmentType()

Will return the attachment type of the attachment

Returns:

The value from the attachment type enumeration

getAdditionalColumn

public java.lang.String getAdditionalColumn(java.lang.String key,
                                            java.lang.String defaultValue)

Will return the value of the column provided. If the value is null or empty then the default value will be provided.

Parameters:

key - The column id or key of the additional column. An additional column is one which is not core to the sdiattachment table such as a user added column.

defaultValue - The default value to return if the column does not exist, the additional columns is empty or the value is null.

Returns:

Returns the value of the additional column or the default value provided.

getSDCId

public java.lang.String getSDCId()

Get the SDC Id

Returns:

Returns the sdc id

getKeyId1

public java.lang.String getKeyId1()

Get the key id 1

Returns:

Returns the key id 1

getKeyId2

public java.lang.String getKeyId2()

Get the key id 2

Returns:

Returns the key id 2

getKeyId3

public java.lang.String getKeyId3()

Get the key id 3

Returns:

Returns the key id 3

getAttachmentNum

public int getAttachmentNum()

Returns the attachment number

Returns:

The attachment number

getAttachmentClass

public java.lang.String getAttachmentClass()

Returns the attachment class

Returns:

The attachment class

getTempId

public java.lang.String getTempId()

Returns the Temporary Id for the SDI Temp record Note this is used internally when uploading an attachment prior to save on a maintenance page. The attachment is placed in sdi temp and then stored in sdiattachment when the save routines are called.

Returns:

The temporary id

setTempId

public void setTempId(java.lang.String tempid)

Sets the temporary id for the sdi temp record. Note this is used internally when uploading an attachment prior to save on a maintenance page. The attachment is placed in sdi temp and then stored in sdiattachment when the save routines are called.

Parameters:

tempid - The temporary id for the sdi temp record

setRepositoryId

public void setRepositoryId(java.lang.String repositoryId)

Set the external id for the external repository. This is not the repository property tree id, but the id used to identify the attachment in the external repository. For instance in the NetworkFileRepostiory this would be the filepath, but in the AWS repository this would be a unique GUID.

Parameters:

repositoryId - The external repository id.

getRepositoryId

public java.lang.String getRepositoryId()

Get the external id for the external repository. This is not the repository property tree id, but the id used to identify the attachment in the external repository. For instance in the NetworkFileRepostiory this would be the filepath, but in the AWS repository this would be a unique GUID.

Parameters:

repositoryId - The external repository id.

setAttachmentClass

public void setAttachmentClass(java.lang.String attclass)

Set the attachment class for the attachment.

Parameters:

attclass - The attachment class

getType

public java.lang.String getType()

Get the attachment type flag. Please note this is only required when dealing with backwards compatiable attachments. Use the getAttachmentType which returns the Attachment Type enumeration for the newer functionality.

Returns:

Returns the type flag

getSourceFilename

public java.lang.String getSourceFilename()

Returns the source filename of the attachment. This is the filename as it was uploaded or referenced and not the filename as it is stored in the repositories.

Returns:

Returns the source filename.

setSourceFilename

public void setSourceFilename(java.lang.String sourcefilename)

Sets the source filename of the attachment.

Parameters:

sourcefilename - The source filename.

getOleClass

public java.lang.String getOleClass()

Gets the OLE class. This the OLE class for the attachment. This is used for backwards compatibility with older Systems and should no longer be in use.

Returns:

The OLE class

setOleClass

public void setOleClass(java.lang.String oleClass)

Sets the OLE class. This the OLE class for the attachment. This is used for backwards compatibility with older Systems and should no longer be in use.

Parameters:

oleClass - The OLE Class

setFilename

public void setFilename(java.lang.String filename)

Sets the filename of the attachment. Use this when referencing an attachment rather than uploading.

Parameters:

filename - The filename of the attachment.

setDescription

public void setDescription(java.lang.String description)

Sets the description of the attachment.

Parameters:

description - The description

setData

public void setData(byte[] data)

Sets the file data for the attachment. It is recommended to deal with Streams and Channels for efficiency instead of arrays of bytes in memory.

Parameters:

data - The data for the file in a byte array.

getFilename

public java.lang.String getFilename()

Returns the file name of the attachment. This will be the filename of the stored attachment and may not be the same as the source filename.

Returns:

The filename of the attachment.

getBlob

public java.sql.Blob getBlob()

Returns the blob value. We recommend using the getInputStream instead and deal with managing the streams and channels for efficiency.

Returns:

The blob object.

setBlob

public void setBlob(java.sql.Blob blob)

Sets the blob object on the attachment. We recommend using the setInputStream instead and deal with managing the streams and channels for efficiency.

Parameters:

blob - The blob object

getDescription

public java.lang.String getDescription()

Returns the attachment description

Returns:

The description

setInputStream

public void setInputStream(java.io.InputStream in)

Sets the input stream for adding/updating a new attachment We recommend using this over setting the byte array or blob of the attachment for efficiency and memory management

Parameters:

in - The input stream for the attachment.

getInputStream

public java.io.InputStream getInputStream()

Gets the input stream for adding/updating an attachment We recommend using this over getting the byte array or blob of the attachment for efficiency and memory management

Returns:

Returns the input stream for the attachment

getSize

public long getSize()

Gets the size of the data in the attachment

Returns:

The size in bytes of the attachment

getData

public byte[] getData(int maxsizelimit)

Gets the data in the attachment as a byte array. We recommend using the getInputStream instead and working with streams and channels for better efficiency and memory management

Parameters:

maxsizelimit - The maximum size of the data to return.

Returns:

Returns the byte array representing the data in the attachment.

hasData

public boolean hasData()

Returns true if the attachment has data in it and that data is available to read. Internally this simply checks the inputstream is not null and has data.

Returns:

Return true if the attachment has data and false if not

getData

public byte[] getData()

Gets the data in the attachment as a byte array. We recommend using the getInputStream instead and working with streams and channels for better efficiency and memory management

Returns:

Returns the byte array representing the data in the attachment.

setClob

public void setClob(java.lang.String clob)

Used to set the clob column on the attachment. This column is used for richtext and plain text attachments as well as storing the markup for image based file attachments.

Parameters:

clob - The string data for the clob column

getClob

public java.lang.String getClob()

Used to get the clob column on the attachment. This column is used for richtext and plain text attachments as well as storing the markup for image based file attachments.

Returns:

Returns the string value of the clob column

setThumbnailImage

public void setThumbnailImage(java.lang.String thumbnailimage)

Sets the thumnail image of the attachment. This is a base64 encoded PNG image.

Parameters:

thumbnailimage - The Base64 encoded thumbnail image

getThumbnailImage

public java.lang.String getThumbnailImage()

Gets the thumnail image of the attachment. This is a base64 encoded PNG image.

Returns:

returns the Base64 encoded thumbnail image

getLinkSdcid

public java.lang.String getLinkSdcid()

Gets the Link SDC Id if the attachment is a linked attachment created from a copy down.

Returns:

Returns the link sdc id

getLinkKeyId1

public java.lang.String getLinkKeyId1()

Gets the Link Key Id 1 if the attachment is a linked attachment created from a copy down.

Returns:

Returns the link key id 1

getLinkKeyId2

public java.lang.String getLinkKeyId2()

Gets the Link Key Id 2 if the attachment is a linked attachment created from a copy down.

Returns:

Returns the link key id 2

getLinkKeyId3

public java.lang.String getLinkKeyId3()

Gets the Link Key Id 3 if the attachment is a linked attachment created from a copy down.

Returns:

Returns the link key id 3

getLinkAttachmentNum

public int getLinkAttachmentNum()

Gets the Link Attachment Number if the attachment is a linked attachment created from a copy down.

Returns:

Returns the link Attachment Number

isHashed

public boolean isHashed()

Returns true if the data inside the attachment has been hashed Internally this returns trus if the datahash of the attachment is not 0. You may also find that the input stream is that of a digested hash stream as hashing may occur on reading of the input stream.

Returns:

Returns true if data has been hashed.

isInvalidHash

public boolean isInvalidHash()

Returns true if hashing failed and the attachment has an invalid has. Internally if the attachment is hashed then the CRC check occurs on reading the attachment inputstream. This property is then updated depending on if that reading of the input stream is successful.

Returns:

Returns true for an invalid hash and false if the hash is valid

isCompressed

public boolean isCompressed()

Returns true if the attachment was compressed in storage. By the time you read the input stream the internal mechanics or local caching would have uncompressed the attachment.

Returns:

Returns true if the attachment is compressed

setCompressed

public void setCompressed(boolean compressedFlag)

Set to true if you wish to force compression. Thus the attachment rules will be ignored for comression and this will force compression to occur on saving of the attachment.

Parameters:

compressedFlag - Set to true to force compression.

isEncrypted

public boolean isEncrypted()

Returns true if the attachment was encrypted in storage. By the time you read the input stream the internal mechanics decrypted the attachment. Please note that if local caching is enabled that the data will still be encrypted in the local cache.

Returns:

Returns true if the attachment is encrypted

setEncrypted

public void setEncrypted(boolean encryptedFlag)

Set to true to encrypt the attachment and force this over the rules evaluation.

Parameters:

encryptedFlag - Set to true to force encryption of the attachment

getUrl

public java.lang.String getUrl()

Returns the URL if a URL attachment.

Returns:

The URL

generateThumbnail

public void generateThumbnail(java.lang.String connectionid)
                       throws SapphireException

Will generate the thumbnail and populate the Thumbnail property of the attachment object.

Throws:

SapphireException

getLockAttachment

public boolean getLockAttachment()

Returns true if the attachment is locked from update as part of version control.

Returns:

True if the attachment is locked and false if not.

setLockAttachment

public void setLockAttachment(boolean lockAttachment)

Set to true to lock the attachment for update from others and to allow version control.

Parameters:

lockAttachment - Set to true to lock the attachment and false to unlock it

evaluateFileNameExpressions

public static java.lang.String evaluateFileNameExpressions(java.lang.String sdcid,
                                                           java.lang.String keyid1,
                                                           java.lang.String keyid2,
                                                           java.lang.String keyid3,
                                                           int attachmentnum,
                                                           ConnectionInfo connectionInfo,
                                                           java.lang.String input,
                                                           Attachment attachment)

evaluateFileNameExpressions

public static java.lang.String evaluateFileNameExpressions(java.lang.String sdcid,
                                                           java.lang.String keyid1,
                                                           java.lang.String keyid2,
                                                           java.lang.String keyid3,
                                                           int attachmentnum,
                                                           int auditsequence,
                                                           ConnectionInfo connectionInfo,
                                                           java.lang.String input,
                                                           Attachment attachment)

replaceDateTokens

public static java.lang.String replaceDateTokens(java.lang.String filename)

replaceDbTokens

public static java.lang.String replaceDbTokens(java.lang.String filename,
                                               java.lang.String sdcid,
                                               java.lang.String keyid1,
                                               java.lang.String keyid2,
                                               java.lang.String keyid3,
                                               Attachment attachment,
                                               ConnectionInfo connectionInfo)

replaceInvalidChars

public static java.lang.String replaceInvalidChars(java.lang.String tokens,
                                                   java.lang.String replacement)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object