oracle.ifs.beans

Class Format

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SystemObject

oracle.ifs.beans.TieSystemObject

oracle.ifs.beans.Format

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieFormat

public class Format
extends TieSystemObject

The Format class represents the known formats of document content. Examples of formats are type of word processor file, or a specific encoding of video. The format is used to determine how best to store and retrieve a document's content, as well as how a client should render it. The format class maintains the content MIME type, which is used by web browsers and other internet clients.

You should specify a document's format whenever you create a document with content. Two collections of formats can be retrieved from the current LibrarySession. The collections contain the same formats; one allows a lookup by format name, and the other by format file extension (for example, "html").

Note that you need to have admin privileges to create or modify document formats.

Version:

1.0

Author:

Larry Matter

See Also:

Document

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	BINARY_ATTRIBUTE An indicator of whether this Format is textual or binary.
static String	CLASS_NAME This class name for this class.
static String	DEFAULT_FORMAT_NAME Name of the default format that is used when the extension is not known.
static String	EXTENSION_ATTRIBUTE A three letter file extension associated with this Format (e.g. txt).
static String	INDEXED_ATTRIBUTE Whether content is full-text indexed.
static String	MIMETYPE_ATTRIBUTE The MIME type of this Format (e.g. text/html).
static String	NAME_ATTRIBUTE The name of this Format (e.g.

Fields inherited from class oracle.ifs.beans.SystemObject

ACTIVE_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Format(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a Format object - standard variant.

Method Summary

Modifier and Type	Method and Description
protected static Format	constructFormat(LibrarySession sess, S_LibraryObjectData data) constructFormat - FixmeJavadocMethod
protected static Vector	constructFormatVector(LibrarySession sess, Vector vector) constructFormatVector - FixmeJavadocMethod
static Format[]	findAll(LibrarySession session) Returns the set of defined Formats.
static Format	findByExtension(LibrarySession session, String extension) Returns the a Format matching the specified extension.
static Format	findByName(LibrarySession session, String name) Returns the a Format matching the specified name.
static Long	getClassId(LibrarySession session) Get the ID of the ClassObject representing FORMAT.
static Format	getDefaultFormat(LibrarySession session) Gets the "default" format, to be used when no existing format matches identification criteria (e.g. file extension or mime type).
String	getExtension() returns the local file extension associated with this Format.
static Format	getFormatByFilename(LibrarySession session, String filename) Derives a format based on the extension of the given filename.
static LibraryObjectLookupCache	getLibraryObjectLookupCache(LibrarySessionInterface session) Returns the LibraryObjectLookupCache used by find Format instances by name.
static LibraryObjectLookupCache	getLibraryObjectLookupCacheByExtension(LibrarySessionInterface session) Returns the LibraryObjectLookupCache used by find Format instances by EXTENSION.
String	getMimeType() returns the MIME type of this Format
boolean	hasNameAttribute() Override to return true for any PublicObject, indicating that the instance has a NAME attribute.
boolean	isBinary() returns true if this format describes binary content, false if text.
boolean	isIndexed() Gets whether content is indexed.
void	setBinary(boolean isBinary) Marks this format as either binary (true) or text (false)
void	setExtension(String FileExtension) Associates a local file extension with this Format.
void	setMimeType(String mimeType) Associates MIME type with this Format.
protected static Format	vectorFormatElement(Vector vector, int index) Returns a Format from a vector of Formats
protected static Format[]	vectorToFormatArray(Vector vector) Constructs an array of Format's from a vector of Formats

Methods inherited from class oracle.ifs.beans.SystemObject

addCategory, constructSystemObject, constructSystemObjectVector, free, freeCategories, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasPropertyBundleAttribute, isActive, postCreate, postUpdate, preCreate, preUpdate, putPolicy, removeAllPolicies, removePolicy, removePolicy, setActive, setPolicyBundle, setPolicyLists

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getDefinitionForSimplePropertyUpdates, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, preFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

This class name for this class. Useful for methods that take a class name argument.

See Also:

Constant Field Values

(Published)

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

The name of this Format (e.g. Text).

See Also:

Constant Field Values

(Published)

MIMETYPE_ATTRIBUTE

public static final String MIMETYPE_ATTRIBUTE

The MIME type of this Format (e.g. text/html).

See Also:

Constant Field Values

(Published)

BINARY_ATTRIBUTE

public static final String BINARY_ATTRIBUTE

An indicator of whether this Format is textual or binary.

See Also:

Constant Field Values

(Published)

INDEXED_ATTRIBUTE

public static final String INDEXED_ATTRIBUTE

Whether content is full-text indexed.

See Also:

Constant Field Values

(Published)

EXTENSION_ATTRIBUTE

public static final String EXTENSION_ATTRIBUTE

A three letter file extension associated with this Format (e.g. txt).

See Also:

Constant Field Values

(Published)

DEFAULT_FORMAT_NAME

public static final String DEFAULT_FORMAT_NAME

Name of the default format that is used when the extension is not known.

See Also:

Constant Field Values

(Published)

Constructor Detail

Format

protected Format(LibrarySession session,
                 Long id,
                 Long classId,
                 S_LibraryObjectData data)
          throws IfsException

Construct a Format object - standard variant.

Parameters:

session - current session context

id - object ID

classId - object's Class ID

data - the object's data

Throws:

IfsException - if operation fails.

(Unpublished)

Method Detail

getClassId

public static Long getClassId(LibrarySession session)
                       throws IfsException

Get the ID of the ClassObject representing FORMAT.

Parameters:

session - the session context

Returns:

the ID of the FORMAT ClassObject

Throws:

IfsException - if the operation fails

(Unpublished)

hasNameAttribute

public boolean hasNameAttribute()
                         throws IfsException

Override to return true for any PublicObject, indicating that the instance has a NAME attribute.

Overrides:

hasNameAttribute in class LibraryObject

Returns:

true.

Throws:

IfsException - if operation fails.

(Published)

getExtension

public String getExtension()
                    throws IfsException

returns the local file extension associated with this Format.

Returns:

the local file extension associated with this Format.

Throws:

IfsException - on failure

(Published)

setExtension

public void setExtension(String FileExtension)
                  throws IfsException

Associates a local file extension with this Format. Formats are associated with one extension only.

Parameters:

FileExtension - a file extension to associate with this Format.

Throws:

IfsException - on failure

(Published)

isBinary

public boolean isBinary()
                 throws IfsException

returns true if this format describes binary content, false if text.

Returns:

true if this format describes binary content, false if text.

Throws:

IfsException - on failure

(Published)

setBinary

public void setBinary(boolean isBinary)
               throws IfsException

Marks this format as either binary (true) or text (false)

Parameters:

isBinary - true if binary, false if text

Throws:

IfsException - on failure

(Published)

isIndexed

public boolean isIndexed()
                  throws IfsException

Gets whether content is indexed.

Returns:

whether indexed

Throws:

IfsException - if the operation fails

(Published)

getMimeType

public String getMimeType()
                   throws IfsException

returns the MIME type of this Format

Returns:

the MIME type of this Format

Throws:

IfsException - on failure

(Published)

setMimeType

public void setMimeType(String mimeType)
                 throws IfsException

Associates MIME type with this Format.

Parameters:

mimeType - a MIME type to associate with this Format.

Throws:

IfsExc2Yeption - on failure

IfsException

(Published)

getFormatByFilename

public static Format getFormatByFilename(LibrarySession session,
                                         String filename)
                                  throws IfsException

Derives a format based on the extension of the given filename.

Parameters:

session - the session context

filename - the filename to map to a Format

Returns:

the Format based on the file extension of the given filename, or the "bin" Format if no Format maps to the filename.

Throws:

IfsException - if the "bin" Format could not be found, or if an error occurs

(Unpublished)

getDefaultFormat

public static Format getDefaultFormat(LibrarySession session)
                               throws IfsException

Gets the "default" format, to be used when no existing format matches identification criteria (e.g. file extension or mime type).

Parameters:

session - the session context

Returns:

the default Format

Throws:

IfsException - if the default Format is not present, or if an error occurs

(Unpublished)

getLibraryObjectLookupCache

public static LibraryObjectLookupCache getLibraryObjectLookupCache(LibrarySessionInterface session)
                                                            throws IfsException

Returns the LibraryObjectLookupCache used by find Format instances by name.

Parameters:

session - the session context

Returns:

the LibraryObjectLookupCache

Throws:

IfsException - if the operation fails.

getLibraryObjectLookupCacheByExtension

public static LibraryObjectLookupCache getLibraryObjectLookupCacheByExtension(LibrarySessionInterface session)
                                                                       throws IfsException

Returns the LibraryObjectLookupCache used by find Format instances by EXTENSION.

Parameters:

session - the session context

Returns:

the LibraryObjectLookupCache

Throws:

IfsException - if the operation fails.

findAll

public static Format[] findAll(LibrarySession session)
                        throws IfsException

Returns the set of defined Formats.

The instances will be sorted by name.

Parameters:

session - the session context

Returns:

the set of Formats; returns null if there are none

Throws:

IfsException - if the operation fails.

findByName

public static Format findByName(LibrarySession session,
                                String name)
                         throws IfsException

Returns the a Format matching the specified name.

Parameters:

session - the session context

name - the Format name

Returns:

the Format matching the specified name; or null if there exists no matching Format

Throws:

IfsException - if the operation fails.

findByExtension

public static Format findByExtension(LibrarySession session,
                                     String extension)
                              throws IfsException

Returns the a Format matching the specified extension.

Parameters:

session - the session context

extension - the Format extension

Returns:

the Format matching the specified extension; or null if there exists no matching Format

Throws:

IfsException - if the operation fails.

constructFormatVector

protected static Vector constructFormatVector(LibrarySession sess,
                                              Vector vector)
                                       throws IfsException

constructFormatVector - FixmeJavadocMethod

Parameters:

sess - - FixmeJavadocParam

vector - - FixmeJavadocParam

Returns:

Vector - FixmeJavadocReturn

Throws:

IfsException - if operation fails.

(Unpublished)

constructFormat

protected static Format constructFormat(LibrarySession sess,
                                        S_LibraryObjectData data)
                                 throws IfsException

constructFormat - FixmeJavadocMethod

Parameters:

sess - - FixmeJavadocParam

data - - FixmeJavadocParam

Returns:

Format - FixmeJavadocReturn

Throws:

IfsException - if operation fails.

(Unpublished)

vectorToFormatArray

protected static Format[] vectorToFormatArray(Vector vector)

Constructs an array of Format's from a vector of Formats

Parameters:

vector - - FixmeJavadocParam

Returns:

Format[] - FixmeJavadocReturn

(Unpublished)

vectorFormatElement

protected static Format vectorFormatElement(Vector vector,
                                            int index)

Returns a Format from a vector of Formats

Parameters:

vector - - FixmeJavadocParam

index - - FixmeJavadocParam

Returns:

Format - FixmeJavadocReturn

(Unpublished)