com.oberon.ooql.sdk
Class FileType

java.lang.Object
  com.oberon.ooql.sdk.OBBase
      com.oberon.ooql.sdk.AdminBase
          com.oberon.ooql.sdk.FileType

All Implemented Interfaces:

java.io.Serializable

public class FileType
extends AdminBase
implements java.io.Serializable

FileType Admin Object: defines file mime format.

Version:

5.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.oberon.ooql.sdk.AdminBase

bsOptions, HIDDEN_OPTION

Constructor Summary

FileType()

FileType(java.lang.String name)

Method Summary

java.lang.String	compareUpdate(FileType refFileType, boolean checkImage, boolean overwrite, boolean force, Framework framework) Return/apply the OOQL command to update this FileType object and let it become equals to another reference object.
void	create(boolean force, Framework framework) Create a new FileType object on the database
void	create(Framework framework) Create a new FileType object on the database
void	destroy(Framework framework) Remove the FileType object from the database
void	fromXML(org.jdom.Element rootElement) Load the FileType object properties from XML element tree
java.lang.String	getCreateCommand(boolean force) Return the OOQL command to create this FileType object with the settled properties
java.lang.String	getExtension() Return the file extension for this FileType.
java.util.Vector<java.lang.String>	getLifecycles(Framework framework) Return the list of Lifecycles that allow this FileType
java.lang.String	getLifecyclesAsString(java.lang.String delim, Framework framework) Return the list of Lifecycles that allow this FileType, as a String
java.lang.String	getMimeType() Return the file MIME type for this FileType.
java.lang.String	getProperty(java.lang.String propertyName, java.util.Vector<java.lang.Object> filterArgs, java.lang.String token, Framework framework) Get a property for this FileType object by its OOQL identifier
java.lang.String	getSaveCommand(boolean force) Return the OOQL command to update this FileType object with the modified properties.
java.util.Vector<?>	getTargetNames(java.lang.String composedName, java.util.Vector<java.lang.Object> filterArgs, Framework framework) Return a Vector of administrative object names extracted by using an OOQL selector
void	link(Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters) Open the FileType object: connect the memory instance with the database instance
static FileType	open(java.lang.String name, Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters) Open an administrative object and read properties from the database or retrieve them from memory
void	setExtension(java.lang.String extension) Set file extension for this FileType.
void	setMimeType(java.lang.String mimeType) Set file MIME type for this FileType.
java.lang.String	toString() Return the FileType object basic properties as a single String
java.lang.String	toString(Framework framework) Return the FileType object extended properties as a single String
org.jdom.Element	toXML(boolean getImage, boolean fullDump, Framework framework) Return the FileType object properties as XML element tree
org.jdom.Element	toXML(Framework framework) Return the FileType object properties as XML element tree
void	unlink(Framework framework) Close the object: disconnect the memory instance from the database instance
void	write(boolean force, Framework framework) Update the FileType object to the database
void	write(Framework framework) Update the FileType object to the database

Methods inherited from class com.oberon.ooql.sdk.AdminBase

addFeature, changedApplication, checkChangeName, checkCounters, checkCounters, getAdminType, getApplication, getCommonProperty, getCommonTargetNames, getCounters, getCreateBasicCommand, getCreateCommand, getCrtDate, getDescription, getEditBasicCommand, getFeature, getFeatures, getFeaturesAsString, getImage, getImage, getImage, getImageData, getImageFile, getModDate, getModUser, getName, getOldName, getPlainFeatures, getSaveCommand, getSVNRevision, getXMLFeatureList, hasImage, isHidden, setApplication, setCounters, setCrtDate, setDescription, setHidden, setImage, setImageData, setImageFile, setModDate, setModUser, setName, setSVNRevision, show, show, toCommonXML, toXML

Methods inherited from class com.oberon.ooql.sdk.OBBase

addChange, addUniqueChange, ChangesFromXML, ChangesToXML, getChanges, getChangesAsString, getId, isLinked, removeChange, resetChanges, setId, setLinked

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FileType

public FileType()

FileType

public FileType(java.lang.String name)
         throws OberonException

Parameters:

name - the name of the administrative object

Throws:

OberonException - if the name contains invalid characters

Method Detail

open

public static FileType open(java.lang.String name,
                            Framework framework,
                            java.util.Hashtable<java.lang.String,java.lang.Integer> counters)
                     throws OberonException

Open an administrative object and read properties from the database or retrieve them from memory

Parameters:

name - the object name

framework - the current framework

counters - administrative object synch counters (if null read them from database)

Throws:

OberonException - usually due to DB SQL exceptions

link

public void link(Framework framework,
                 java.util.Hashtable<java.lang.String,java.lang.Integer> counters)
          throws OberonException

Open the FileType object: connect the memory instance with the database instance

Specified by:

link in class AdminBase

Parameters:

framework - the current framework

counters - administrative object synch counters (if null read them from database)

Throws:

OberonException - usually due to DB SQL exceptions

create

public void create(Framework framework)
            throws OberonException

Create a new FileType object on the database

Specified by:

create in class AdminBase

Parameters:

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

create

public void create(boolean force,
                   Framework framework)
            throws OberonException

Create a new FileType object on the database

Parameters:

force - if true ignores optional features

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

Since:

1.6

write

public void write(Framework framework)
           throws OberonException

Update the FileType object to the database

Specified by:

write in class AdminBase

Parameters:

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

write

public void write(boolean force,
                  Framework framework)
           throws OberonException

Update the FileType object to the database

Parameters:

force - if true ignores optional features

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

Since:

1.6

unlink

public void unlink(Framework framework)
            throws OberonException

Close the object: disconnect the memory instance from the database instance

Specified by:

unlink in class AdminBase

Parameters:

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions

destroy

public void destroy(Framework framework)
             throws OberonException

Remove the FileType object from the database

Specified by:

destroy in class AdminBase

Parameters:

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

setExtension

public void setExtension(java.lang.String extension)

Set file extension for this FileType.

Parameters:

extension - the file extension (example: ".gif" / ".jpg" / ".doc" )

getExtension

public java.lang.String getExtension()

Return the file extension for this FileType.

setMimeType

public void setMimeType(java.lang.String mimeType)

Set file MIME type for this FileType.

Parameters:

mimeType - the file extension (example: "application/msword" / "text/plain" ..)

getMimeType

public java.lang.String getMimeType()

Return the file MIME type for this FileType.

getLifecycles

public java.util.Vector<java.lang.String> getLifecycles(Framework framework)

Return the list of Lifecycles that allow this FileType

Parameters:

framework - the current framework

Returns:

vector of Lifecycles names

getLifecyclesAsString

public java.lang.String getLifecyclesAsString(java.lang.String delim,
                                              Framework framework)

Return the list of Lifecycles that allow this FileType, as a String

Parameters:

delim - the separator item

framework - the current framework

Returns:

list of Lifecycles separated by the delim characters

getProperty

public java.lang.String getProperty(java.lang.String propertyName,
                                    java.util.Vector<java.lang.Object> filterArgs,
                                    java.lang.String token,
                                    Framework framework)

Get a property for this FileType object by its OOQL identifier

Specified by:

getProperty in class OBBase

Parameters:

propertyName - OOQL property identifier/name (example: extension , mimetype ...)

filterArgs - extra arguments used to compute properties

token - separator token for complex properties

framework - the current framework

Returns:

the property value

getTargetNames

public java.util.Vector<?> getTargetNames(java.lang.String composedName,
                                          java.util.Vector<java.lang.Object> filterArgs,
                                          Framework framework)

Return a Vector of administrative object names extracted by using an OOQL selector

Specified by:

getTargetNames in class OBBase

Parameters:

composedName - OOQL property identifier/name (example: lifecycle .. )

filterArgs - extra arguments used to compute properties

framework - the current framework

Returns:

a Vector of target names, used to extract their (sub)properties values

toString

public java.lang.String toString()

Return the FileType object basic properties as a single String

Overrides:

toString in class AdminBase

toString

public java.lang.String toString(Framework framework)

Return the FileType object extended properties as a single String

Overrides:

toString in class AdminBase

Parameters:

framework - the current framework

toXML

public org.jdom.Element toXML(Framework framework)

Return the FileType object properties as XML element tree

Specified by:

toXML in class AdminBase

Parameters:

framework - the current framework

toXML

public org.jdom.Element toXML(boolean getImage,
                              boolean fullDump,
                              Framework framework)

Return the FileType object properties as XML element tree

Specified by:

toXML in class AdminBase

Parameters:

getImage - true to include "imagedata" element with the base64 encoded image data

fullDump - true to include detailed information

framework - the current framework

fromXML

public void fromXML(org.jdom.Element rootElement)

Load the FileType object properties from XML element tree

Overrides:

fromXML in class AdminBase

getCreateCommand

public java.lang.String getCreateCommand(boolean force)

Return the OOQL command to create this FileType object with the settled properties

Specified by:

getCreateCommand in class AdminBase

Parameters:

force - if true append the "force" options at the end

getSaveCommand

public java.lang.String getSaveCommand(boolean force)

Return the OOQL command to update this FileType object with the modified properties.
If the object is new, it returns the create command.

Specified by:

getSaveCommand in class AdminBase

Parameters:

force - if true append the "force" options at the end

compareUpdate

public java.lang.String compareUpdate(FileType refFileType,
                                      boolean checkImage,
                                      boolean overwrite,
                                      boolean force,
                                      Framework framework)
                               throws OberonException

Return/apply the OOQL command to update this FileType object and let it become equals to another reference object.
This method is useful to import objects from an XML file.

Parameters:

refFileType - the reference FileType object

checkImage - if true compare also the image icon

overwrite - if true update the database object instance

force - if true ignores optional properties

framework - the current framework

Throws:

OberonException

See Also:

fromXML(Element)