/*
* Geotoolkit - An Open Source Java GIS Toolkit
* http://www.geotoolkit.org
*
* (C) 2010, Geomatys
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package org.geotoolkit.xal.model;
/**
* <p></p>
*
* <p>Specification of the identifier of a sub-premise.
* Examples of sub-premises are apartments and suites.
* sub-premises in a building are often uniquely identified
* by means of consecutive identifiers.</p>
*
* <p>The identifier can be a number, a letter or any combination of the two.
* In the latter case, the identifier includes exactly one variable (range) part,
* which is either a number or a single letter that is surrounded
* by fixed parts at the left (prefix) or the right (postfix).</p>
*
* <pre>
* <xs:complexType mixed="true">
* <xs:attribute name="Indicator">...
* </xs:attribute>
* <xs:attribute name="IndicatorOccurrence">...
* </xs:attribute>
* <xs:attribute name="NumberTypeOccurrence">...
* </xs:attribute>
* <xs:attribute name="PremiseNumberSeparator">...
* </xs:attribute>
* <xs:attribute name="Type"/>
* <xs:attributeGroup ref="grPostal"/>
* <xs:anyAttribute namespace="##other"/>
* </xs:complexType>
* </pre>
*
* @author Samuel Andrés
* @module
*/
public interface SubPremiseNumber extends GenericTypedGrPostal {
/**
* <p>"TH" in 12TH which is a floor number, "NO." in NO.1, "#" in APT #12, etc.</p>
*
* @return
*/
String getIndicator();
/**
* <p>"No." occurs before 1 in No.1, or TH occurs after 12 in 12TH.</p>
*
* @return
*/
AfterBeforeEnum getIndicatorOccurrence();
/**
* <p>12TH occurs "before" FLOOR (a type of subpremise) in 12TH FLOOR.</p>
*
* @return
*/
AfterBeforeEnum getNumberTypeOccurrence();
/**
* <p>"/" in 12/14 Archer Street where 12 is sub-premise number and 14 is premise number.</p>
*
* @return
*/
String getPremiseNumberSeparator();
/**
*
* @param indicator
*/
void setIndicator(String indicator);
/**
*
* @param indicatorOccurrence
*/
void setIndicatorOccurrence(AfterBeforeEnum indicatorOccurrence);
/**
*
* @param numberTypeOccurrence
*/
void setNumberTypeOccurrence(AfterBeforeEnum numberTypeOccurrence);
/**
*
* @param premiseNumberSeparator
*/
void setPremiseNumberSeparator(String premiseNumberSeparator);
}