dk.heick.properties.types

Class FileStructurePropertyType

java.lang.Object

dk.heick.properties.PropertyType<File>

dk.heick.properties.types.FileStructurePropertyType

All Implemented Interfaces:

MarkerPathPropertyType, Serializable

public class FileStructurePropertyType
extends PropertyType<File>
implements MarkerPathPropertyType

This property type initialize and validates a file structure from a root directory point of view.
Typical some applications has some directory structure with some files which it is dependent on is created currently and exists.

It is actually quite simple it validates and initialize a file structure from a root directory node, which is the property value.
Example:

• ROOT [dir]
• configuration [dir]
• users.xml [file]
• reports.xml [file]
• reports [dir]
• active [dir]
• inactive [dir]
• temp [dir]
• deleted [dir]

All this is dependent on where the root directory is setup to be.
This property type is constructed with an instance of of the structure shall verify and initialize.
It will return a java.io.File of the root directory which is retrieved from the PropertyIO.

So what you need to do is to defined the structure that your application requires, setup one property which gives your the root directory.
Than the type will initialize the structure and you can retrieve the directories and files directly from the defined structure.

 
 public final static RootDirectoryNode DIR_ROOT = new RootDirectoryNode();
        
 public final static DirectoryNode DIR_CONF = new DirectoryNode("conf",DIR_ROOT);
 public final static DirectoryNode DIR_REPORTS = new DirectoryNode("reports",DIR_ROOT);
 public final static DirectoryNode DIR_REPORTS_ACTIVE = new DirectoryNode("active",DIR_REPORTS);
 public final static DirectoryNode DIR_REPORTS_INACTIVE = new DirectoryNode("inactive",DIR_REPORTS);
 public final static DirectoryNode DIR_TEM P= new DirectoryNode("temp",DIR_ROOT);
 public final static DirectoryNode DIR_DELETED = new DirectoryNode("deleted",DIR_ROOT);
 
 public final static FileNode FILE_USERS_XML = new FileNode("users.xml",DIR_CONF);
 public final static FileNode FILE_REPORTS_XML = new FileNode("reports.xml",DIR_CONF);
 

Than the type constructor will be :

Property<File> A_PROPERTY = new Property<File>("a.property.name", new FileStructurePropertyType(DIR_ROOT));

When loaded and validated, you can get the java.io.File from any node by using the getFile().

DIR_REPORTS_ACTIVE.getFile()

And you can be sure that the directory exists, and upholds the rules of the validator.

Again when loaded and validated you get the root directory node.

A_PROPERTY.getRootDirectoryNode()

and you will have the valid directory to work from.

Each node can have its own specific file validator, example would be validating that a file is well formed xml file.
There is a default implementation of the FileValidator for files and directories.

This type has NO default value, if validation fails, null is returned.

Since:

1.1

Author:

Frederik Heick

See Also:

RootDirectoryNode, DirectoryNode, FileNode, FilterFileNode, AbstractTreeNode, FileValidator, DefaultDirectoryValidator, DefaultFileValidator, DefaultXmlFileValidator, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE The type name string constant of FileStructurePropertyType

Constructor Summary

Constructors

Constructor and Description
FileStructurePropertyType() Constructor, an instance of RootDirectoryNode MUST be set at a later time.
FileStructurePropertyType(RootDirectoryNode rootDirectoryNode) Constructor, requires a instance of RootDirectoryNode.
FileStructurePropertyType(RootDirectoryNodeLocator rootDirectoryNodeLocator) Constructor.

Method Summary

Modifier and Type	Method and Description
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
RootDirectoryNode	getRootDirectoryNode() The root node of the file structure.
RootDirectoryNodeLocator	getRootDirectoryNodeLocator() Gets the implementation of RootDirectoryNodeLocator.
void	setRootDirectoryNode(RootDirectoryNode rootDirectoryNode) Sets the RootDirectoryNode for where the File structure eminates.
void	setRootDirectoryNodeLocator(RootDirectoryNodeLocator rootDirectoryNodeLocator) Sets the rootDirectoryNodeLocator.
String	toString(String propertyName, File t) Converts a typed to the string representation.
void	validateConstraints(String propertyName) Will invalidate if: The RootDirectoryNodeLocater is null. The RootDirectoryNode is null.
File	validateValue(String propertyName, String value) Converts the string representation of to a typed value.

Methods inherited from class dk.heick.properties.PropertyType

equals, getDefaultValue, getDefaultValueAsString, getDefaultValueDescription, getDescription, getDescription, getInitializationPriority, getIo, getLogger, getTypeName, hasDefaultValue, isDefaultValueValid, postGetValueProcessing, setDefaultValue, setInitializationPriority, setIo, setTypedValue, setTypeName, toType, validate, validateNullType

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

The type name string constant of FileStructurePropertyType

See Also:

Constant Field Values

Constructor Detail

FileStructurePropertyType

public FileStructurePropertyType()

Constructor, an instance of RootDirectoryNode MUST be set at a later time.

FileStructurePropertyType

public FileStructurePropertyType(RootDirectoryNode rootDirectoryNode)

Constructor, requires a instance of RootDirectoryNode.

Parameters:

rootDirectoryNode - the root node of the file structure to initialize and validate. This will set the RootDirectoryNode in a instance of DefaultRootDirectoryNodeLocator.

See Also:

setRootDirectoryNode(RootDirectoryNode), DefaultRootDirectoryNodeLocator

FileStructurePropertyType

public FileStructurePropertyType(RootDirectoryNodeLocator rootDirectoryNodeLocator)

Constructor.

Parameters:

rootDirectoryNodeLocator - an implementation of RootDirectoryNodeLocator interface. If null than either RootDirectoryNodeLocator or RootDirectoryNode MUST be set at a later time.

Method Detail

getRootDirectoryNodeLocator

public RootDirectoryNodeLocator getRootDirectoryNodeLocator()

Gets the implementation of RootDirectoryNodeLocator.

Returns:

the rootDirectoryNodeLocator.

See Also:

RootDirectoryNodeLocator

setRootDirectoryNodeLocator

public void setRootDirectoryNodeLocator(RootDirectoryNodeLocator rootDirectoryNodeLocator)

Sets the rootDirectoryNodeLocator.

Parameters:

rootDirectoryNodeLocator - the RootDirectoryNodeLocator.

getRootDirectoryNode

public RootDirectoryNode getRootDirectoryNode()

The root node of the file structure.

Returns:

the root directory node.

setRootDirectoryNode

public void setRootDirectoryNode(RootDirectoryNode rootDirectoryNode)

Sets the RootDirectoryNode for where the File structure eminates.
This is wrapped inside a DefaultRootDirectoryNodeLocator.

Parameters:

rootDirectoryNode - the root directory node.

See Also:

DefaultRootDirectoryNodeLocator

getRestrictions

public List<String> getRestrictions()

Description copied from class: PropertyType

Gets a detailed description of the PropertyType with any constraints that might influence the validation.
This includes a description for the default value, if the default do not it self parse the validation of the type, the exception is appended to the description.

Specified by:

getRestrictions in class PropertyType<File>

Returns:

the restrictions of the PropertyType as a list of strings.

validateValue

public File validateValue(String propertyName,
                          String value)
                   throws PropertyException

Description copied from class: PropertyType

Converts the string representation of to a typed value.
Including validation of any restrictions the PropertyType might have.
See the individual property type class description for details on how it convert to a typed value.

IMPORTANT: This only validates the value not the constraints of the PropertyType, which is at this point assumed to be valid.

Specified by:

validateValue in class PropertyType<File>

Parameters:

propertyName - the name of the property used for logging purposes. To uniquely identify the Property with validation issues.

value - the string representation of the property

Returns:

the typed converted value.

Throws:

PropertyException - if the conversion failed.

validateConstraints

public void validateConstraints(String propertyName)
                         throws PropertyException

Will invalidate if:

• The RootDirectoryNodeLocater is null.
• The RootDirectoryNode is null.

Overrides:

validateConstraints in class PropertyType<File>

Parameters:

propertyName - the name of the property used for logging purposes, to identify the unique property which PropertyType has constraint issues.

Throws:

PropertyException - if the constraints have invalid/conflicting values.

See Also:

Property.validate()

toString

public String toString(String propertyName,
                       File t)
                throws PropertyException

Description copied from class: PropertyType

Converts a typed to the string representation. This must be associative, so the string generate here will successful validate. This is enforced, so the converted string is sub sequencetially validate with the validate method. In some of the property sub types, this method is overridden to ensure above rule.

Overrides:

toString in class PropertyType<File>

Parameters:

propertyName - the name of the property used for logging purposes.

t - the type T.

Returns:

The string representation of the type.

Throws:

PropertyException - if conversion failed in validation.

See Also:

PropertyType.validate(String, String)