com.edustructures.sifworks.common
Class Street

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.common.Street

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Street
extends SIFKeyedElement

The Street element is a complex element that breaks a street address down into several parts

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

Street()
Constructor

Street(java.lang.String line1)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getApartmentNumber() Gets the value of the <ApartmentNumber> element.
java.lang.String	getApartmentNumberPrefix() Gets the value of the <ApartmentNumberPrefix> element.
java.lang.String	getApartmentNumberSuffix() Gets the value of the <ApartmentNumberSuffix> element.
java.lang.String	getApartmentType() Gets the value of the <ApartmentType> element.
java.lang.String	getComplex() Gets the value of the <Complex> element.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
java.lang.String	getLine1() Gets the value of the <Line1> element.
java.lang.String	getLine2() Gets the value of the <Line2> element.
java.lang.String	getLine3() Gets the value of the <Line3> element.
java.lang.String	getStreetName() Gets the value of the <StreetName> element.
java.lang.String	getStreetNumber() Gets the value of the <StreetNumber> element.
java.lang.String	getStreetPrefix() Gets the value of the <StreetPrefix> element.
java.lang.String	getStreetSuffix() Gets the value of the <StreetSuffix> element.
java.lang.String	getStreetType() Gets the value of the <StreetType> element.
void	setApartmentNumber(java.lang.String value) Sets the value of the <ApartmentNumber> element.
void	setApartmentNumberPrefix(java.lang.String value) Sets the value of the <ApartmentNumberPrefix> element.
void	setApartmentNumberSuffix(java.lang.String value) Sets the value of the <ApartmentNumberSuffix> element.
void	setApartmentType(java.lang.String value) Sets the value of the <ApartmentType> element.
void	setComplex(java.lang.String value) Sets the value of the <Complex> element.
void	setLine1(java.lang.String value) Sets the value of the <Line1> element.
void	setLine2(java.lang.String value) Sets the value of the <Line2> element.
void	setLine3(java.lang.String value) Sets the value of the <Line3> element.
void	setStreetName(java.lang.String value) Sets the value of the <StreetName> element.
void	setStreetNumber(java.lang.String value) Sets the value of the <StreetNumber> element.
void	setStreetPrefix(java.lang.String value) Sets the value of the <StreetPrefix> element.
void	setStreetSuffix(java.lang.String value) Sets the value of the <StreetSuffix> element.
void	setStreetType(java.lang.String value) Sets the value of the <StreetType> element.

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Street

public Street()

Constructor

Street

public Street(java.lang.String line1)

Constructor that accepts values for all mandatory fields

Parameters:

line1 - Address line 1.

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

getLine1

public java.lang.String getLine1()

Gets the value of the <Line1> element.

The SIF specification defines the meaning of this element as: "Address line 1."

Returns:

The Line1 element of this object.

Since:

1.1

setLine1

public void setLine1(java.lang.String value)

Sets the value of the <Line1> element.

The SIF specification defines the meaning of this element as: "Address line 1."

Parameters:

value - A String object

Since:

1.1

getLine2

public java.lang.String getLine2()

Gets the value of the <Line2> element.

The SIF specification defines the meaning of this element as: "Address line 2."

Returns:

The Line2 element of this object.

Since:

1.1

setLine2

public void setLine2(java.lang.String value)

Sets the value of the <Line2> element.

The SIF specification defines the meaning of this element as: "Address line 2."

Parameters:

value - A String object

Since:

1.1

getLine3

public java.lang.String getLine3()

Gets the value of the <Line3> element.

The SIF specification defines the meaning of this element as: "Address line 3."

Returns:

The Line3 element of this object.

Since:

1.1

setLine3

public void setLine3(java.lang.String value)

Sets the value of the <Line3> element.

The SIF specification defines the meaning of this element as: "Address line 3."

Parameters:

value - A String object

Since:

1.1

getComplex

public java.lang.String getComplex()

Gets the value of the <Complex> element.

The SIF specification defines the meaning of this element as: "Name of the complex."

Returns:

The Complex element of this object.

Since:

1.1

setComplex

public void setComplex(java.lang.String value)

Sets the value of the <Complex> element.

The SIF specification defines the meaning of this element as: "Name of the complex."

Parameters:

value - A String object

Since:

1.1

getStreetNumber

public java.lang.String getStreetNumber()

Gets the value of the <StreetNumber> element.

The SIF specification defines the meaning of this element as: "The address number assigned to the building."

Returns:

The StreetNumber element of this object.

Since:

1.1

setStreetNumber

public void setStreetNumber(java.lang.String value)

Sets the value of the <StreetNumber> element.

The SIF specification defines the meaning of this element as: "The address number assigned to the building."

Parameters:

value - A String object

Since:

1.1

getStreetPrefix

public java.lang.String getStreetPrefix()

Gets the value of the <StreetPrefix> element.

The SIF specification defines the meaning of this element as: "Street prefix like NE"

Returns:

The StreetPrefix element of this object.

Since:

1.1

setStreetPrefix

public void setStreetPrefix(java.lang.String value)

Sets the value of the <StreetPrefix> element.

The SIF specification defines the meaning of this element as: "Street prefix like NE"

Parameters:

value - A String object

Since:

1.1

getStreetName

public java.lang.String getStreetName()

Gets the value of the <StreetName> element.

The SIF specification defines the meaning of this element as: "The name of the street."

Returns:

The StreetName element of this object.

Since:

1.1

setStreetName

public void setStreetName(java.lang.String value)

Sets the value of the <StreetName> element.

The SIF specification defines the meaning of this element as: "The name of the street."

Parameters:

value - A String object

Since:

1.1

getStreetType

public java.lang.String getStreetType()

Gets the value of the <StreetType> element.

The SIF specification defines the meaning of this element as: "The type of street. For example, Lane, Blvd., Ave., etc."

Returns:

The StreetType element of this object.

Since:

1.1

setStreetType

public void setStreetType(java.lang.String value)

Sets the value of the <StreetType> element.

The SIF specification defines the meaning of this element as: "The type of street. For example, Lane, Blvd., Ave., etc."

Parameters:

value - A String object

Since:

1.1

getStreetSuffix

public java.lang.String getStreetSuffix()

Gets the value of the <StreetSuffix> element.

The SIF specification defines the meaning of this element as: "Street suffix like SW."

Returns:

The StreetSuffix element of this object.

Since:

1.1

setStreetSuffix

public void setStreetSuffix(java.lang.String value)

Sets the value of the <StreetSuffix> element.

The SIF specification defines the meaning of this element as: "Street suffix like SW."

Parameters:

value - A String object

Since:

1.1

getApartmentType

public java.lang.String getApartmentType()

Gets the value of the <ApartmentType> element.

The SIF specification defines the meaning of this element as: "Type of apartment, for example, Suite."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"AptType"
SIF2.0	"ApartmentType"

Returns:

The ApartmentType element of this object.

Since:

1.1

setApartmentType

public void setApartmentType(java.lang.String value)

Sets the value of the <ApartmentType> element.

The SIF specification defines the meaning of this element as: "Type of apartment, for example, Suite."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"AptType"
SIF2.0	"ApartmentType"

Parameters:

value - A String object

Since:

1.1

getApartmentNumberPrefix

public java.lang.String getApartmentNumberPrefix()

Gets the value of the <ApartmentNumberPrefix> element.

The SIF specification defines the meaning of this element as: "Apartment number prefix."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"AptNumPrefix"
SIF2.0	"ApartmentNumberPrefix"

Returns:

The ApartmentNumberPrefix element of this object.

Since:

1.1

setApartmentNumberPrefix

public void setApartmentNumberPrefix(java.lang.String value)

Sets the value of the <ApartmentNumberPrefix> element.

The SIF specification defines the meaning of this element as: "Apartment number prefix."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"AptNumPrefix"
SIF2.0	"ApartmentNumberPrefix"

Parameters:

value - A String object

Since:

1.1

getApartmentNumber

public java.lang.String getApartmentNumber()

Gets the value of the <ApartmentNumber> element.

The SIF specification defines the meaning of this element as: "The number of the apartment."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"AptNumber"
SIF2.0	"ApartmentNumber"

Returns:

The ApartmentNumber element of this object.

Since:

1.1

setApartmentNumber

public void setApartmentNumber(java.lang.String value)

Sets the value of the <ApartmentNumber> element.

The SIF specification defines the meaning of this element as: "The number of the apartment."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"AptNumber"
SIF2.0	"ApartmentNumber"

Parameters:

value - A String object

Since:

1.1

getApartmentNumberSuffix

public java.lang.String getApartmentNumberSuffix()

Gets the value of the <ApartmentNumberSuffix> element.

The SIF specification defines the meaning of this element as: "Apartment number suffix."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"AptNumSuffix"
SIF2.0	"ApartmentNumberSuffix"

Returns:

The ApartmentNumberSuffix element of this object.

Since:

1.1

setApartmentNumberSuffix

public void setApartmentNumberSuffix(java.lang.String value)

Sets the value of the <ApartmentNumberSuffix> element.

The SIF specification defines the meaning of this element as: "Apartment number suffix."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"AptNumSuffix"
SIF2.0	"ApartmentNumberSuffix"

Parameters:

value - A String object

Since:

1.1