org.dlese.dpc.schemedit.config

Class SchemaPath

java.lang.Object

org.dlese.dpc.schemedit.config.SchemaPath

All Implemented Interfaces:

java.io.Serializable

public class SchemaPath
extends java.lang.Object
implements java.io.Serializable

Provides information about a schema element that is not expressed in the XML Schema, but that is helpful in displaying and editing documents within a framework.

For example, a SchemaPath provides information when a new metadata record is created or copied, such as which elements should be blanked out, which are required by the Indexer, and which should be displayed as read-only fields in the metadata editor.

SchemaPath instances are created by the FrameworkConfigReader as it reads the configuration file for a particular framework. These SchemaPath instances are stored in a SchemaPathMap structure, which is used mainly by the MetaDataFramework class.

Author:

ostwald

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	defaultValue An optional default for this element
java.lang.String	initialFieldCollapse
java.lang.String	inputHelper
int	maxLen
java.lang.String	pathName A short name (such as "url") that can be used to access the instance by name.
boolean	readOnly Is this element required (by the indexer) to be present in all records?
boolean	requiredByCopyRecord Description of the Field
boolean	requiredByMinimalRecord Is this element required by the copyRecord
java.lang.String	valueType A String used to (somewhat informally) describe the type of the element
java.lang.String	xpath The xpath in the Schema to which this SchemaPath instance refers.

Constructor Summary

Constructors

Constructor and Description
SchemaPath(org.dom4j.Element e) Constructor for the SchemaPath object
SchemaPath(java.lang.String pathName, java.lang.String xpath, java.lang.String defaultValue, java.lang.String valueType, java.lang.String inputHelper, java.lang.String initialFieldCollapse, boolean requiredByCopyRecord, boolean readOnly, boolean requiredByMinimalRecord) Constructor for the SchemaPath object

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString() Description of the Method

Methods inherited from class java.lang.Object

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

Field Detail

pathName

public java.lang.String pathName

A short name (such as "url") that can be used to access the instance by name.

xpath

public java.lang.String xpath

The xpath in the Schema to which this SchemaPath instance refers.

defaultValue

public java.lang.String defaultValue

An optional default for this element

valueType

public java.lang.String valueType

A String used to (somewhat informally) describe the type of the element

inputHelper

public java.lang.String inputHelper

initialFieldCollapse

public java.lang.String initialFieldCollapse

maxLen

public int maxLen

requiredByCopyRecord

public boolean requiredByCopyRecord

Description of the Field

requiredByMinimalRecord

public boolean requiredByMinimalRecord

Is this element required by the copyRecord

readOnly

public boolean readOnly

Is this element required (by the indexer) to be present in all records?

Constructor Detail

SchemaPath

public SchemaPath(java.lang.String pathName,
                  java.lang.String xpath,
                  java.lang.String defaultValue,
                  java.lang.String valueType,
                  java.lang.String inputHelper,
                  java.lang.String initialFieldCollapse,
                  boolean requiredByCopyRecord,
                  boolean readOnly,
                  boolean requiredByMinimalRecord)

Constructor for the SchemaPath object

Parameters:

pathName - Description of the Parameter

xpath - Description of the Parameter

defaultValue - Description of the Parameter

valueType - Description of the Parameter

requiredByCopyRecord - Description of the Parameter

readOnly - Description of the Parameter

requiredByMinimalRecord - Description of the Parameter

SchemaPath

public SchemaPath(org.dom4j.Element e)

Constructor for the SchemaPath object

Parameters:

e - Description of the Parameter

Method Detail

toString

public java.lang.String toString()

Description of the Method

Overrides:

toString in class java.lang.Object

Returns:

Description of the Return Value