com.highqsoft.xsd

Class ExternalReferenceRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.ExternalReferenceRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class ExternalReferenceRule
extends AbstractRule

This is the abstract rule.

Since:

$Date: 2017/04/06 13:30:30 $

Version:

$Revision: 1.13 $

Author:

Andreas Hofmann

See Also:

RuleIF

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.ResourceBundle	MIMETYPE

Fields inherited from class com.highqsoft.xsd.AbstractRule

loggerName, postMethods, preMethods, sessionRef

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
ExternalReferenceRule()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	finalize()
java.lang.String	getDescription() Get the description of the external reference.
java.lang.String	getDir() Get the directory specification.
java.lang.String	getLocation() Get the location of the external reference.
java.lang.String	getMimetype() Get the mimetype string.
NameValueUnit[][]	getValue() Return the url of the external reference as string.
void	init() Init the rule.
boolean	isOverwrite() Inquire the overwrite flag.
protected int	searchFor(T_ExternalReference[] refs, java.lang.String description, java.lang.String mimetype, java.lang.String location) Search for the reference that matches the given parameters.
void	setDescription(java.lang.String description) Set the description of the external reference.
void	setDir(java.lang.String dir, boolean createDir) Set the directory.
void	setLocation(java.lang.String location) Set the location of the external reference.
void	setMimetype(java.lang.String mimetype) Set the mimetype string.
void	setOverwrite(boolean overwrite) Set the overwrite flag.
void	setValue(NameValueUnit[][] nvuArr) Set the filename that should be save as external reference.

Methods inherited from class com.highqsoft.xsd.AbstractRule

execute, execute, executePostMethods, executePreMethods, getAoSessionFromContextWithSessionRef, getId, getOdsCache, getPointTo, getSessionRef, getType, isPedantic, setGathermode, setId, setPointTo, setPostMethods, setPreMethods, setSessionRef, setType, terminate, toString, toString, toString

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setArguments, setContext, setDescriptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Field Detail

MIMETYPE

protected static java.util.ResourceBundle MIMETYPE

Constructor Detail

ExternalReferenceRule

public ExternalReferenceRule()

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

init

public void init()
          throws InitializationFailedException

Init the rule.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

setDescription

public void setDescription(java.lang.String description)

Set the description of the external reference.

Parameters:

description - the new description.

getDescription

public java.lang.String getDescription()

Get the description of the external reference.

Returns:

the description.

setLocation

public void setLocation(java.lang.String location)

Set the location of the external reference.

Parameters:

location - the new location.

getLocation

public java.lang.String getLocation()

Get the location of the external reference.

Returns:

the location.

setOverwrite

public void setOverwrite(boolean overwrite)

Set the overwrite flag.

Parameters:

overwrite - the overwrite flag.

isOverwrite

public boolean isOverwrite()

Inquire the overwrite flag.

Returns:

the overwriteflag.

setMimetype

public void setMimetype(java.lang.String mimetype)

Set the mimetype string.

Parameters:

mimetype - the mimetype

getMimetype

public java.lang.String getMimetype()

Get the mimetype string.

Returns:

the mimetype.

setDir

public void setDir(java.lang.String dir,
          boolean createDir)

Set the directory.

Parameters:

dir - the directory specification

getDir

public java.lang.String getDir()

Get the directory specification.

Returns:

the string presentation of the directory.

getValue

public NameValueUnit[][] getValue()

Return the url of the external reference as string. This is the remote filename information.

Returns:

the named value of url of the external reference.

See Also:

RuleIF.setValue(NameValueUnit[][] nvu)

searchFor

protected int searchFor(T_ExternalReference[] refs,
            java.lang.String description,
            java.lang.String mimetype,
            java.lang.String location)

Search for the reference that matches the given parameters. If more than one refernce match, the first one will be returned.

Parameters:

refs - The sequence of external refernces.

description - the description that should match. null means every.

mimetype - the mimetype that should match. null means every.

location - the location that should match. null means every.

Returns:

the index of the matching element or -1 if not found.

setValue

public void setValue(NameValueUnit[][] nvuArr)

Set the filename that should be save as external reference. This is the local filename information.

Parameters:

nvu - the named filename value.