|
Esri Geoportal Server 1.0
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.gpt.catalog.schema.Component com.esri.gpt.catalog.schema.Content
public class Content
Content component associated with a metadata schema.
The component is configured from a node with a schema configuration XML document. Example:
Field Summary | |
---|---|
static String |
NODETYPE_GCOLIST
GCO List node type = "gcoList" |
static String |
NODETYPE_ISOCODELISTVALUE
ISO code list value = "isoCodeListValue" This node type is represented by a duplication of an ISO code in both a codeListValue attribute and the text node of the attributes's parent element. |
static String |
NODETYPE_LIST
List node type = "list" |
static String |
NODETYPE_PAIRLEFTVALUE
Single node type = "single" (this is the default) |
static String |
NODETYPE_PAIRRIGHTVALUE
Single node type = "single" (this is the default) |
static String |
NODETYPE_SINGLE
Single node type = "single" (this is the default) |
Constructor Summary | |
---|---|
Content()
Default constructor. |
|
Content(Content objectToDuplicate)
Construct by duplicating an existing object. |
Method Summary | |
---|---|
void |
clearAllValues()
Clears single and multiple values. |
void |
configure(CfgContext context,
Node node,
NamedNodeMap attributes)
Configures the object based upon a node loaded from a schema configuration XML. |
static void |
deleteNodes(Document dom,
XPath xpath,
String expression)
Deletes nodes from a document based upon an XPath expression. |
Content |
duplicate()
Produces a deep clone of the object. |
void |
echo(StringBuffer sb)
Appends property information for the component to a StringBuffer. |
void |
evaluate(Document dom,
XPath xpath,
Parameter parameter)
Evaluates the XPath select expression associated with a parameter. |
String |
formatValue(Parameter parameter,
String value)
Formats a value associated with a parameter. |
Codes |
getCodes()
Gets the codes for this parameter. |
String |
getDelete()
Gets the XPath expression used to select nodes for deletion when an updated value is empty. |
boolean |
getDeleteIfEmpty()
Indicates if the node associated with the update expression should be deleted if the updated value is empty. |
boolean |
getDeleteParentIfEmpty()
Indicates if the parent node associated with the update expression should be deleted if the updated value is empty. |
ContentValues |
getMultipleValues()
Gets the multiple value list. |
String |
getNilReasonPath()
Gets the XPath expression used to a ISO nil-reason attribute associated with this element. |
String |
getNodeType()
Gets the node type. |
String |
getSelect()
Gets the XPath selection expression. |
ContentValue |
getSingleValue()
Gets the single value. |
String |
getUpdate()
Gets the XPath expression used to select nodes for update. |
boolean |
getUseSelectForUpdate()
Gets the status indicating if the selection expression should be used for locating nodes during the update process. |
boolean |
isSingleValue()
Determines if the node type is of single value. |
boolean |
isValueEmpty()
Determines if the node value(s) is/are empty. |
String |
makeDisplayValue(MessageBroker messageBroker,
Parameter parameter)
Makes the display value for a parameter. |
protected void |
setCodes(Codes codes)
Sets the codes for this parameter. |
void |
setDelete(String expression)
Sets the XPath expression used to select nodes for deletion when an updated value is empty. |
void |
setDeleteIfEmpty(boolean deleteIfEmpty)
Indicates if the node(s) associated with the update expression should be deleted if the updated value is empty. |
void |
setDeleteParentIfEmpty(boolean deleteIfEmpty)
Indicates if the node(s) associated with the update expression should be deleted if the updated value is empty. |
protected void |
setMultipleValues(ContentValues values)
Sets the multiple value list |
void |
setNilReasonPath(String expression)
Sets the XPath expression used to a ISO nil-reason attribute associated with this element. |
void |
setNodeType(String type)
Sets the node type. |
void |
setSelect(String expression)
Sets the XPath selection expression. |
protected void |
setSingleValue(ContentValue value)
Sets the single value. |
void |
setUpdate(String expression)
Sets the XPath expression used to select nodes for update. |
void |
setUseSelectForUpdate(boolean useSelectForUpdate)
Sets the status indicating if the selection expression should be used for locating nodes during the update process. |
String[] |
toValueArray()
Generates a String array of value(s) associated with the parameter. |
void |
update(Document dom,
XPath xpath,
Parameter parameter)
Updates the metadata document based upon entered parameter value(s). |
Methods inherited from class com.esri.gpt.catalog.schema.Component |
---|
getKey, setKey, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String NODETYPE_GCOLIST
public static final String NODETYPE_ISOCODELISTVALUE
public static final String NODETYPE_LIST
public static final String NODETYPE_SINGLE
public static final String NODETYPE_PAIRRIGHTVALUE
public static final String NODETYPE_PAIRLEFTVALUE
Constructor Detail |
---|
public Content()
public Content(Content objectToDuplicate)
objectToDuplicate
- the object to duplicateMethod Detail |
---|
public Codes getCodes()
protected void setCodes(Codes codes)
codes
- the value codespublic String getDelete()
public void setDelete(String expression)
expression
- the delete expressionpublic boolean getDeleteIfEmpty()
public void setDeleteIfEmpty(boolean deleteIfEmpty)
deleteIfEmpty
- true if the node should be deleted when the updated value is emptypublic boolean getDeleteParentIfEmpty()
public void setDeleteParentIfEmpty(boolean deleteIfEmpty)
deleteIfEmpty
- true if the node should be deleted when the updated value is emptypublic ContentValues getMultipleValues()
protected void setMultipleValues(ContentValues values)
values
- the multiple value listpublic String getNilReasonPath()
public void setNilReasonPath(String expression)
expression
- the nil-reason expressionpublic String getNodeType()
public void setNodeType(String type)
type
- the node typepublic String getSelect()
public void setSelect(String expression)
expression
- the selection expressionpublic ContentValue getSingleValue()
protected void setSingleValue(ContentValue value)
value
- the single valuepublic String getUpdate()
public void setUpdate(String expression)
expression
- the update expressionpublic boolean getUseSelectForUpdate()
public void setUseSelectForUpdate(boolean useSelectForUpdate)
useSelectForUpdate
- true if the selection expression
should be used for updatepublic void clearAllValues()
public void configure(CfgContext context, Node node, NamedNodeMap attributes)
configure
in class Component
context
- the configuration contextnode
- the configuration nodeattributes
- the attributes of the configuration nodepublic static void deleteNodes(Document dom, XPath xpath, String expression) throws XPathExpressionException
dom
- the metadata document template for the schemaxpath
- an XPath object configured with an appropriate
Namespace context for the schemaexpression
- the expression to use to delete the nodes
XPathExpressionException
- if an expression fails
SchemaException
- if the update failspublic Content duplicate()
duplicate
in class Component
public void echo(StringBuffer sb)
echo
in class Component
sb
- the StringBuffer to use when appending informationpublic void evaluate(Document dom, XPath xpath, Parameter parameter) throws XPathExpressionException
dom
- the metadata documentxpath
- an XPath object configured with an appropriate
Namespace context for the schemaparameter
- the associated parameter
XPathExpressionException
- if an evaluation expression failspublic String formatValue(Parameter parameter, String value)
parameter
- the associated parametervalue
- the value to formatpublic boolean isSingleValue()
public boolean isValueEmpty()
public String makeDisplayValue(MessageBroker messageBroker, Parameter parameter)
messageBroker
- the message brokerparameter
- the associated parameter
public String[] toValueArray()
public void update(Document dom, XPath xpath, Parameter parameter) throws XPathExpressionException, SchemaException
dom
- the metadata document template for the schemaxpath
- an XPath object configured with an appropriate
Namespace context for the schemaparameter
- the associated parameter
XPathExpressionException
- if an expression fails
SchemaException
- if the update fails
|
Esri Geoportal Server 1.0
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |