com.ibm.etools.iseries.projects.core
Class IBMiPropertiesType

java.lang.Object
  com.ibm.etools.iseries.projects.core.IBMiPropertiesType

Direct Known Subclasses:

IBMiSavfPropertiesType

public abstract class IBMiPropertiesType
extends Object

This set of singletons describes the type of IBM i properties that a particular IBM i project IResource might have In particular it knows what sets of property keys are defined for that type and whether they are team shared or user shared. It also knows where to find the .properties files where they are persisted.

Field Summary

static IBMiPropertiesType	BINARY_OBJ
static IBMiPropertiesType	MEMBER
static IBMiPropertiesType	PROJECT
static IBMiPropertiesType	SAVF
static IBMiPropertiesType	SRC_PF

Constructor Summary

IBMiPropertiesType()

Method Summary

String	getDefaultValue(QualifiedName key) Returns the default value for the property named by this key.
static IResource	getProjectModelResource(IResource metadataFile) Return the IResource of the iProject model object being described by the given metadata properties file
abstract IResource	getProjectResourceFromPropertiesLocation(IResource metadataFile) Map from a metadata resource for teamed shared properties to the described project resource
PropertyDefinition	getPropertyDefinition(QualifiedName key) Returns the property definition for a named property.
protected abstract String	getResourceType()
abstract IPath	getTeamPropertiesLocationFor(IPath resourceRelativePath) Returns the relative path of the team properties location for the given relative path.
abstract IPath	getTeamPropertiesLocationFor(IResource resource) Return the metadata resource for teamed shared properties given the described project resource
boolean	hasDefaultValue(QualifiedName key) Tests whether the property named by this key has a declared default value.

Methods inherited from class java.lang.Object

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

Field Detail

PROJECT

public static final IBMiPropertiesType PROJECT

SRC_PF

public static final IBMiPropertiesType SRC_PF

MEMBER

public static final IBMiPropertiesType MEMBER

SAVF

public static final IBMiPropertiesType SAVF

BINARY_OBJ

public static final IBMiPropertiesType BINARY_OBJ

Constructor Detail

IBMiPropertiesType

public IBMiPropertiesType()

Method Detail

getProjectModelResource

public static IResource getProjectModelResource(IResource metadataFile)

Return the IResource of the iProject model object being described by the given metadata properties file

Parameters:

metadataFile - the properties file

Returns:

the IResource of the associated ISeriesResource

getTeamPropertiesLocationFor

public abstract IPath getTeamPropertiesLocationFor(IResource resource)

Return the metadata resource for teamed shared properties given the described project resource

getProjectResourceFromPropertiesLocation

public abstract IResource getProjectResourceFromPropertiesLocation(IResource metadataFile)

Map from a metadata resource for teamed shared properties to the described project resource

getTeamPropertiesLocationFor

public abstract IPath getTeamPropertiesLocationFor(IPath resourceRelativePath)

Returns the relative path of the team properties location for the given relative path.

Parameters:

resourceRelativePath - the resource relative path.

Returns:

the relative path of the metadata file.

getResourceType

protected abstract String getResourceType()

getDefaultValue

public String getDefaultValue(QualifiedName key)

Returns the default value for the property named by this key. If the property is not defined or it has no default specified then the empty string is returned.

Parameters:

key - The key that names a property.

Returns:

The default value for this property.

hasDefaultValue

public boolean hasDefaultValue(QualifiedName key)

Tests whether the property named by this key has a declared default value.

Parameters:

key - The key that names a property.

Returns:

true if the default value was explicitly declared, false otherwise.

getPropertyDefinition

public PropertyDefinition getPropertyDefinition(QualifiedName key)

Returns the property definition for a named property.

Parameters:

key - The name of the property.

Returns:

The property definition for that property or null if the property is not declared.