Package de.xima.fc.mdl.form

Class FormResource

java.lang.Object

de.xima.fc.mdl.form.FormResource

All Implemented Interfaces:

IFormResource, Serializable

public class FormResource
extends Object
implements IFormResource

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
FormResource(String name, EFormResourceType type, String resName, byte[] resData, String cacheKey)	Deprecated. Use formResourcePlugin(String, String, String, EFormResourceType, String, byte[], String) or formResourcesPlugin(String, String, String, EFormResourceType, String, byte[], String).

Method Summary

Modifier and Type	Method	Description
static IFormResource	formResourcePlugin(String pluginKey, String pluginFileKey, String pluginName, EFormResourceType type, String resName, byte[] resData, String cacheKey)	Creates a form resource provided by a form resource plugin (IFCPluginResource).
static IFormResource	formResourcesPlugin(String pluginKey, String pluginFileKey, String pluginName, EFormResourceType type, String resName, byte[] resData, String cacheKey)	Creates a form resource provided by a form resources plugin (IFCPluginResources).
String	getCacheKey()
String	getName()	Gets the name of the IFCPlugin that provided this resource.
String	getPluginFileKey()	Gets the file key of the resource within the plugin JAR bundle that provided this resource, from the manifest entry Plugin-File-Key.
String	getPluginKey()	Gets the key of the plugin JAR bundle that provided this resource, from the manifest entry Plugin-Key .
byte[]	getResourceData()
String	getResourceName()
EFormResourceType	getResourceType()
EFormResourceSourceType	getSourceType()	Gets the source that provided this resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormResource

@Deprecated
public FormResource(String name,
                    EFormResourceType type,
                    String resName,
                    byte[] resData,
                    String cacheKey)

Deprecated.

Use formResourcePlugin(String, String, String, EFormResourceType, String, byte[], String) or formResourcesPlugin(String, String, String, EFormResourceType, String, byte[], String).

Parameters:

name - Name of the resource.

type - Type of the resource.

resName - Name of the resource.

resData - Data of the resource.

cacheKey - Cache key of the resource.

Method Detail

getCacheKey

public String getCacheKey()

Specified by:

getCacheKey in interface IFormResource

getName

public String getName()

Description copied from interface: IFormResource

Gets the name of the IFCPlugin that provided this resource.

Specified by:

getName in interface IFormResource

Returns:

The name of the IFCPlugin that provided this resource.

getPluginKey

public String getPluginKey()

Description copied from interface: IFormResource

Gets the key of the plugin JAR bundle that provided this resource, from the manifest entry Plugin-Key .

Specified by:

getPluginKey in interface IFormResource

Returns:

The key of the plugin that provided this resource.

getPluginFileKey

public String getPluginFileKey()

Description copied from interface: IFormResource

Gets the file key of the resource within the plugin JAR bundle that provided this resource, from the manifest entry Plugin-File-Key.

Specified by:

getPluginFileKey in interface IFormResource

Returns:

The file key of the resource within the plugin JAR bundle that provided this resource.

getResourceData

public byte[] getResourceData()

Specified by:

getResourceData in interface IFormResource

getResourceName

public String getResourceName()

Specified by:

getResourceName in interface IFormResource

getResourceType

public EFormResourceType getResourceType()

Specified by:

getResourceType in interface IFormResource

getSourceType

public EFormResourceSourceType getSourceType()

Description copied from interface: IFormResource

Gets the source that provided this resource.

Specified by:

getSourceType in interface IFormResource

Returns:

The source that provided this resource.

formResourcePlugin

public static IFormResource formResourcePlugin(String pluginKey,
                                               String pluginFileKey,
                                               String pluginName,
                                               EFormResourceType type,
                                               String resName,
                                               byte[] resData,
                                               String cacheKey)

Creates a form resource provided by a form resource plugin (IFCPluginResource).

Parameters:

pluginKey - The key of the plugin JAR that provides the resource.

pluginFileKey - The file key of the plugin JAR that provides the resource.

pluginName - The name of the IFCPlugin that provides the resource.

type - The type of the resource.

resName - The file name of the resource.

resData - The data of the resource.

cacheKey - The cache key of the resource.

Returns:

The form resource.

formResourcesPlugin

public static IFormResource formResourcesPlugin(String pluginKey,
                                                String pluginFileKey,
                                                String pluginName,
                                                EFormResourceType type,
                                                String resName,
                                                byte[] resData,
                                                String cacheKey)

Creates a form resource provided by a form resources plugin (IFCPluginResources).

Parameters:

pluginKey - The key of the plugin JAR that provides the resource.

pluginFileKey - The file key of the plugin JAR that provides the resource.

pluginName - The name of the IFCPlugin that provides the resource.

type - The type of the resource.

resName - The file name of the resource.

resData - The data of the resource.

cacheKey - The cache key of the resource.

Returns:

The form resource.