wt.fv
Class FvItem

java.lang.Object
  wt.fc.WTObject
      wt.fv.StoredItem
          wt.fv.FvItem

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Revaultable, Serializable, Streamed, UniquelyIdentifiedContent

public class FvItem

extends StoredItem

implements Streamed, Externalizable

Use the newFvItem static factory method(s), not the FvItem constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Nested Class Summary

static class	FvItem.OverflowListener
static class	FvItem.StoreStreamListener

Field Summary

private static String	CLASSNAME
private static boolean	DEBUG
static long	EXTERNALIZATION_VERSION_UID
private long	fileSize
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
private long	revaultSessionId
(package private) static long	serialVersionUID
private long	streamId
private static String	STRING_OF_ZEROES

Fields inherited from class wt.fv.StoredItem

FOLDER, FOLDER_REFERENCE, UNIQUE_SEQUENCE_NUMBER

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.content.Streamed

FILE_SIZE

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.fv.Revaultable

INITIAL_VALUE, REVAULT_SESSION_ID

Fields inherited from interface wt.fv.UniquelyIdentifiedContent

STREAM_ID

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

FvItem()

Method Summary

private static FvItem	buildUniqueName(FvItem item)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getConceptualClassname() Deprecated.
long	getFileSize() Gets the value of the attribute: FILE_SIZE.
long	getRevaultSessionId() Gets the value of the attribute: REVAULT_SESSION_ID.
long	getStreamId() Gets the value of the attribute: STREAM_ID.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
static FvItem	newFvItem() Supported API: false
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(FvItem thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	removeStream() Supported API: false
InputStream	retrieveStream() Supported API: false
void	setFileSize(long a_FileSize) Sets the value of the attribute: FILE_SIZE.
void	setRevaultSessionId(long a_RevaultSessionId) Sets the value of the attribute: REVAULT_SESSION_ID.
void	setStreamId(long a_StreamId) Sets the value of the attribute: STREAM_ID.
Streamed	storeStream(ContentHolder holder, ApplicationData appData, InputStream is) Supported API: false
(package private) Streamed	storeStreamToVault(ObjectReference vaultRef, InputStream is)
private FvItem	trySavingInFolder(FvFolder currentActiveFolder, FvItem item, InputStream is, FvItem.StoreStreamListener listener, ContentHolder holder)
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class wt.fv.StoredItem

buildFileName, getFolder, getFolderReference, getName, getUniqueSequenceNumber, readVersion, setFolder, setFolderReference, setUniqueSequenceNumber

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

fileSize

private long fileSize

revaultSessionId

private long revaultSessionId

streamId

private long streamId

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

DEBUG

private static final boolean DEBUG

See Also:

Constant Field Values

STRING_OF_ZEROES

private static final String STRING_OF_ZEROES

See Also:

Constant Field Values

Constructor Detail

FvItem

public FvItem()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class StoredItem

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class StoredItem

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(FvItem thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class StoredItem

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class StoredItem

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

newFvItem

public static FvItem newFvItem()
                        throws WTException

Supported API: false

Returns:

FvItem

Throws:

WTException

getFileSize

public long getFileSize()

Gets the value of the attribute: FILE_SIZE.

Supported API: false

Specified by:

getFileSize in interface Streamed

Returns:

long

setFileSize

public void setFileSize(long a_FileSize)

Sets the value of the attribute: FILE_SIZE.

Supported API: false

Specified by:

setFileSize in interface Streamed

Parameters:

a_FileSize -

storeStream

public Streamed storeStream(ContentHolder holder,
                            ApplicationData appData,
                            InputStream is)
                     throws WTException

Supported API: false

Specified by:

storeStream in interface Streamed

Parameters:

holder -

appData -

is -

Returns:

Streamed

Throws:

WTException

retrieveStream

public InputStream retrieveStream()
                           throws WTException

Supported API: false

Specified by:

retrieveStream in interface Streamed

Returns:

InputStream

Throws:

WTException

removeStream

public void removeStream()
                  throws WTException

Supported API: false

Specified by:

removeStream in interface Streamed

Throws:

WTException

getRevaultSessionId

public long getRevaultSessionId()

Gets the value of the attribute: REVAULT_SESSION_ID.

Supported API: false

Specified by:

getRevaultSessionId in interface Revaultable

Returns:

long

setRevaultSessionId

public void setRevaultSessionId(long a_RevaultSessionId)

Sets the value of the attribute: REVAULT_SESSION_ID.

Supported API: false

Specified by:

setRevaultSessionId in interface Revaultable

Parameters:

a_RevaultSessionId -

getStreamId

public long getStreamId()

Gets the value of the attribute: STREAM_ID.

Supported API: false

Specified by:

getStreamId in interface UniquelyIdentifiedContent

Returns:

long

setStreamId

public void setStreamId(long a_StreamId)

Sets the value of the attribute: STREAM_ID.

Supported API: false

Specified by:

setStreamId in interface UniquelyIdentifiedContent

Parameters:

a_StreamId -

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class StoredItem

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class StoredItem

Returns:

int

trySavingInFolder

private FvItem trySavingInFolder(FvFolder currentActiveFolder,
                                 FvItem item,
                                 InputStream is,
                                 FvItem.StoreStreamListener listener,
                                 ContentHolder holder)
                          throws WTException

Throws:

WTException

buildUniqueName

private static FvItem buildUniqueName(FvItem item)
                               throws WTException

Throws:

WTException

storeStreamToVault

Streamed storeStreamToVault(ObjectReference vaultRef,
                            InputStream is)
                      throws WTException

Throws:

WTException