IdRegion Enum Reference

Public Member Functions
	IdRegion (String regionName, String subProjectName)
String	getRegionName ()
String	getSubProjectName ()

Static Public Member Functions
static IdRegion	regionFromProject (String projectName)
static IdRegion	regionFromSubProject (String subProjectName)

Public Attributes
	US =("USIDs", "United States")
	ASIA =("AsianIDs", "Asia")
	AUSTRALIA =("AustralianIDs", "Australia")
	CANADA =("CanadianIDs", "Canada")
	AFRICA =("AfricanIDs", "Africa")
	EUROPE =("EuropeanIDs", "Europe")
	LATIN_AMERICA =("LatinAmericanIDs", "Latin America")
	COMBINED =("CombinedIDs", null)
String	_regionName
String	_subProjectName

Detailed Description

Used in conjunction with IdType for extraction to define which region the document being extracted is from.

Constructor & Destructor Documentation

IdRegion	(	String	regionName,
		String	subProjectName
	)

Member Function Documentation

String getRegionName

(

)

Get the corresponding project name for this region

IdRegion.US.getRegionName() // returns "USIDs"

Returns

The project name

String getSubProjectName

(

)

Get the corresponding sub project name for this region

IdRegion.US.getSubProjectName() // returns "United States"

Returns

The project name

static IdRegion regionFromProject ( String  projectName )

static

Get the corresponding IdRegion for this projectName, or null if it does not exist.

Returns

The IdRegion

static IdRegion regionFromSubProject ( String  subProjectName )

static

Get the corresponding IdRegion for this subProjectName, or null if it does not exist.

Returns

The IdRegion

Member Data Documentation

String _regionName

String _subProjectName

AFRICA =("AfricanIDs", "Africa")

ASIA =("AsianIDs", "Asia")

AUSTRALIA =("AustralianIDs", "Australia")

CANADA =("CanadianIDs", "Canada")

COMBINED =("CombinedIDs", null)

EUROPE =("EuropeanIDs", "Europe")

LATIN_AMERICA =("LatinAmericanIDs", "Latin America")

US =("USIDs", "United States")

---

The documentation for this enum was generated from the following file:

• IdRegion.java