org.sourcejammer.project.model.filesys
Class ArchiveInfoFlexFS

java.lang.Object
  |
  +--org.sourcejammer.project.model.filesys.ArchiveInfoFlexFS

All Implemented Interfaces:

ArchiveInfoFlex

public class ArchiveInfoFlexFS

extends java.lang.Object

implements ArchiveInfoFlex

Title: $FileName: ArchiveInfoFlexFS.java$

Version:

$VerNum: 8$

Author:

$AuthorName: Rob MacGrogan$

$Description: Supercedes ArchiveInfoFS and ArchiveInfo2FS.$
$KeyWordsOff: $

Nested Class Summary

(package private) static class

ArchiveInfoFlexFS.XMLNodes

Field Summary

private boolean	keywordExpansionEnabled
private java.util.Hashtable	mhshArchiveControllerUsers
private java.util.Hashtable	mhshArchiveUsers
private java.util.Hashtable	mhshKeywordExpansionExtensions
private java.lang.String	msArchiveName
private java.lang.String	msArchiveRootFileName
private java.lang.String	msPathToArchiveRoot
private static java.lang.String	PLUGIN_TEMPLATE_FILE
private static java.lang.String	PLUGIN_WORK_DIR
private java.util.ArrayList	plugins
private boolean	restricted

Constructor Summary

(package private)	ArchiveInfoFlexFS()
	ArchiveInfoFlexFS(java.lang.String archiveName)

Method Summary

(package private) boolean	addArchiveControllerUser(java.lang.String userName) Just added to help construct new ArchiveInfoFlex from old ArchiveInfo.
boolean	addArchiveControllerUser(User user)
(package private) boolean	addArchiveUser(java.lang.String userName) Just added to help construct new ArchiveInfoFlex from old ArchiveInfo.
boolean	addArchiveUser(User user)
boolean	addKeywordExpandExtension(java.lang.String s) Adds a file type (using the extension) that will have keyword expansion applied if keyword expansion is enabled for the archve.
private void	applyPluginWorkDirectory(PluginFS pfs)
private java.lang.String	booleanString(boolean b)
private boolean	doesPluginExist(PluginFS pfs)
java.lang.String	getArchiveName()
java.util.Enumeration	getControllerUserList() Returns Enumeration of controller usernames.
java.util.Enumeration	getKeywordExpandExtensionList()
java.lang.String	getPathToArchiveRoot()
java.util.ArrayList	getPlugins()
java.util.Enumeration	getUserList() Returns Enumeration of usernames.
boolean	isAnExpansionExtension(java.lang.String extension)
boolean	isAnExpansionFileName(java.lang.String fileName)
boolean	isKeywordExpansionEnabled()
private boolean	isNullOrEmpty(java.lang.String s)
boolean	isRestricted()
boolean	isUserAnArchiveController(User user)
boolean	isUserAnArchiveUser(User user)
boolean	isUserAnArchiveUserOrController(User user)
private void	load(java.lang.String name)
private boolean	loadPluginsFromTemplate() Returns true if one or more plugins loaded.
private org.w3c.dom.Element	loadPluginTemplate() Returns plugins element from archive template file.
boolean	removeArchiveControllerUser(User user)
boolean	removeArchiveUser(User user)
boolean	removeKeywordExpandExtension(java.lang.String s)
void	setArchiveName(java.lang.String name)
void	setArchiveRootFileName(java.lang.String s)
void	setKeywordExpansionEnabled(boolean b)
void	setPathToArchiveRoot(java.lang.String path)
void	setRestricted(boolean b)
void	store()

Methods inherited from class java.lang.Object

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

Field Detail

msArchiveName

private java.lang.String msArchiveName

msPathToArchiveRoot

private java.lang.String msPathToArchiveRoot

msArchiveRootFileName

private java.lang.String msArchiveRootFileName

mhshArchiveControllerUsers

private java.util.Hashtable mhshArchiveControllerUsers

mhshArchiveUsers

private java.util.Hashtable mhshArchiveUsers

mhshKeywordExpansionExtensions

private java.util.Hashtable mhshKeywordExpansionExtensions

restricted

private boolean restricted

keywordExpansionEnabled

private boolean keywordExpansionEnabled

plugins

private java.util.ArrayList plugins

PLUGIN_WORK_DIR

private static final java.lang.String PLUGIN_WORK_DIR

See Also:

Constant Field Values

PLUGIN_TEMPLATE_FILE

private static final java.lang.String PLUGIN_TEMPLATE_FILE

See Also:

Constant Field Values

Constructor Detail

ArchiveInfoFlexFS

ArchiveInfoFlexFS()

ArchiveInfoFlexFS

public ArchiveInfoFlexFS(java.lang.String archiveName)
                  throws FileAccessException,
                         org.sourcejammer.util.SourceJammerVersionException

Method Detail

setKeywordExpansionEnabled

public void setKeywordExpansionEnabled(boolean b)

Specified by:

setKeywordExpansionEnabled in interface ArchiveInfoFlex

getPlugins

public java.util.ArrayList getPlugins()

Specified by:

getPlugins in interface ArchiveInfoFlex

isKeywordExpansionEnabled

public boolean isKeywordExpansionEnabled()

Specified by:

isKeywordExpansionEnabled in interface ArchiveInfoFlex

getArchiveName

public java.lang.String getArchiveName()

Specified by:

getArchiveName in interface ArchiveInfoFlex

setArchiveName

public void setArchiveName(java.lang.String name)

getPathToArchiveRoot

public java.lang.String getPathToArchiveRoot()

setPathToArchiveRoot

public void setPathToArchiveRoot(java.lang.String path)

setArchiveRootFileName

public void setArchiveRootFileName(java.lang.String s)

addArchiveUser

public boolean addArchiveUser(User user)

Specified by:

addArchiveUser in interface ArchiveInfoFlex

addArchiveUser

boolean addArchiveUser(java.lang.String userName)

Just added to help construct new ArchiveInfoFlex from old ArchiveInfo.

addArchiveControllerUser

boolean addArchiveControllerUser(java.lang.String userName)

Just added to help construct new ArchiveInfoFlex from old ArchiveInfo.

removeArchiveUser

public boolean removeArchiveUser(User user)

Specified by:

removeArchiveUser in interface ArchiveInfoFlex

isUserAnArchiveUser

public boolean isUserAnArchiveUser(User user)

Specified by:

isUserAnArchiveUser in interface ArchiveInfoFlex

isAnExpansionExtension

public boolean isAnExpansionExtension(java.lang.String extension)

Specified by:

isAnExpansionExtension in interface ArchiveInfoFlex

isAnExpansionFileName

public boolean isAnExpansionFileName(java.lang.String fileName)

Specified by:

isAnExpansionFileName in interface ArchiveInfoFlex

isUserAnArchiveUserOrController

public boolean isUserAnArchiveUserOrController(User user)

Specified by:

isUserAnArchiveUserOrController in interface ArchiveInfoFlex

addArchiveControllerUser

public boolean addArchiveControllerUser(User user)

Specified by:

addArchiveControllerUser in interface ArchiveInfoFlex

removeArchiveControllerUser

public boolean removeArchiveControllerUser(User user)

Specified by:

removeArchiveControllerUser in interface ArchiveInfoFlex

isUserAnArchiveController

public boolean isUserAnArchiveController(User user)

Specified by:

isUserAnArchiveController in interface ArchiveInfoFlex

getUserList

public java.util.Enumeration getUserList()

Returns Enumeration of usernames.

Specified by:

getUserList in interface ArchiveInfoFlex

getControllerUserList

public java.util.Enumeration getControllerUserList()

Returns Enumeration of controller usernames.

Specified by:

getControllerUserList in interface ArchiveInfoFlex

booleanString

private java.lang.String booleanString(boolean b)

store

public void store()
           throws FileAccessException

Specified by:

store in interface ArchiveInfoFlex

FileAccessException

setRestricted

public void setRestricted(boolean b)

Specified by:

setRestricted in interface ArchiveInfoFlex

isRestricted

public boolean isRestricted()

Specified by:

isRestricted in interface ArchiveInfoFlex

addKeywordExpandExtension

public boolean addKeywordExpandExtension(java.lang.String s)

Description copied from interface: ArchiveInfoFlex

Adds a file type (using the extension) that will have keyword expansion applied if keyword expansion is enabled for the archve.

Specified by:

addKeywordExpandExtension in interface ArchiveInfoFlex

removeKeywordExpandExtension

public boolean removeKeywordExpandExtension(java.lang.String s)

Specified by:

removeKeywordExpandExtension in interface ArchiveInfoFlex

getKeywordExpandExtensionList

public java.util.Enumeration getKeywordExpandExtensionList()

Specified by:

getKeywordExpandExtensionList in interface ArchiveInfoFlex

load

private void load(java.lang.String name)
           throws FileAccessException,
                  org.sourcejammer.util.SourceJammerVersionException

FileAccessException

org.sourcejammer.util.SourceJammerVersionException

loadPluginsFromTemplate

private boolean loadPluginsFromTemplate()
                                 throws java.io.IOException,
                                        org.xml.sax.SAXException

Returns true if one or more plugins loaded.

java.io.IOException

org.xml.sax.SAXException

doesPluginExist

private boolean doesPluginExist(PluginFS pfs)

loadPluginTemplate

private org.w3c.dom.Element loadPluginTemplate()
                                        throws org.xml.sax.SAXException,
                                               java.io.IOException

Returns plugins element from archive template file. Returns null if there is no archive template file in the filesys directory.

org.xml.sax.SAXException

java.io.IOException

applyPluginWorkDirectory

private void applyPluginWorkDirectory(PluginFS pfs)

isNullOrEmpty

private boolean isNullOrEmpty(java.lang.String s)