com.vividsolutions.jump.io

Class ColumnDescription

java.lang.Object

com.vividsolutions.jump.io.ColumnDescription

public class ColumnDescription
extends java.lang.Object

This is a helper class to store information about a JCS Column for the GML Parser (GMLReader).
Also has a function for checking if an XML tag matches this column specification.

Field Summary

Fields

Modifier and Type	Field and Description
static int	VALUE_IS_ATT
static int	VALUE_IS_BODY

Constructor Summary

Constructors

Constructor and Description
ColumnDescription()

Method Summary

Methods

Modifier and Type	Method and Description
AttributeType	getType() Returns the [JCS] type of this column cf. setType()
int	match(java.lang.String XMLtagName, org.xml.sax.Attributes xmlAtts) Given an xml tag (its name and attributes), see if it matches this column description If it doesnt, return 0 If it does, return either VALUE_IS_BODY or VALUE_IS_ATTRIBUTE
void	setColumnName(java.lang.String colname) Set the name of this column.
void	setTagAttribute(java.lang.String attName) Sets the name of the attribute (with no value) that the xml tag that this column will be extracted from.
void	setTagAttribute(java.lang.String attName, java.lang.String attValue) Sets the name of the attribute (and its value) that the xml tag that this column will be extracted from.
void	setTagName(java.lang.String tagname) Sets the name of the XML tag that this column will be extracted from.
void	setType(AttributeType t) Sets the [JCS] type of this column
void	setValueAttribute(java.lang.String attName) Sets the name of the attribute that the actual column's value will be found.

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_IS_BODY

public static final int VALUE_IS_BODY

See Also:

Constant Field Values

VALUE_IS_ATT

public static final int VALUE_IS_ATT

See Also:

Constant Field Values

Constructor Detail

ColumnDescription

public ColumnDescription()

Method Detail

setType

public void setType(AttributeType t)

Sets the [JCS] type of this column

Parameters:

t - JCS type that this column will contain (null means 'STRING')

getType

public AttributeType getType()

Returns the [JCS] type of this column cf. setType()

setColumnName

public void setColumnName(java.lang.String colname)

Set the name of this column.

Parameters:

colname - name of the column

setTagName

public void setTagName(java.lang.String tagname)

Sets the name of the XML tag that this column will be extracted from.

Parameters:

tagname - name of the XML tag

setTagAttribute

public void setTagAttribute(java.lang.String attName,
                   java.lang.String attValue)

Sets the name of the attribute (and its value) that the xml tag that this column will be extracted from.

  For example, the XML '<value type=name> DAVE </value>' would described by:
  setTagName('value');
  setTagAttribute('type','name');

Parameters:

attName - name of the XML attribute name

attValue - its value

setTagAttribute

public void setTagAttribute(java.lang.String attName)

Sets the name of the attribute (with no value) that the xml tag that this column will be extracted from.

  For example, the XML '<value name=david></value>' would described by:
  setTagName('value');
  setTagAttribute('name');

Parameters:

attName - name of the XML attribute name

setValueAttribute

public void setValueAttribute(java.lang.String attName)

Sets the name of the attribute that the actual column's value will be found.

  For example, the XML '<value name=david></value>' would described by:
  setTagName('value');
  setTagAttribute('name');
  setValueAttribute('name');

NOTE: not calling this function will mean to get the column's value from the BODY of the tag.

Parameters:

attName - name of the attribute that the column's value will be extracted from

match

public int match(java.lang.String XMLtagName,
        org.xml.sax.Attributes xmlAtts)

Given an xml tag (its name and attributes), see if it matches this column description
If it doesnt, return 0
If it does, return either VALUE_IS_BODY or VALUE_IS_ATTRIBUTE

Parameters:

XMLtagName - name of the xml tag

xmlAtts - list of the xml attributes for the tag (cf. xerces or SAX)