|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ohf.stem.internal.data.IdentifiableRecord
public abstract class IdentifiableRecord
This class represents a generated Identifiable
such as a
Graph
, Model
, or Scenario
.
Nested Class Summary | |
---|---|
static class |
IdentifiableRecord.AdminLevel
This class represents a UN Administration Level. |
Field Summary | |
---|---|
static java.lang.String |
BIBLIOGRAPHIC_CITATION_PROPERTY
This is the property in a data file that specifies a citation for the data. |
static java.lang.String |
CONTRIBUTOR_PROPERTY
This is the property in a data file that specifies a contributor to the data. |
static java.lang.String |
COVERAGE_PROPERTY
This is the property in a data file that specifies the coverage of the data. |
static java.lang.String |
CREATED_PROPERTY
This is the property in a data file that specifies when the data was created. |
static java.lang.String |
CREATOR_PROPERTY
This is the property in a data file that specifies who created the data. |
static java.lang.String |
DATE_PROPERTY
This is the property in a data file that specifies a date of the data. |
static java.lang.String |
DESCRIPTION_PROPERTY
This is the property in a data file that specifies a description of the data. |
static java.lang.String |
FORMAT_PROPERTY
This is the property in a data file that specifies the format of the the data. |
static java.lang.String |
identifiableURIPrefix
This String is the prefix to use when creating the URI of each Identifiable . |
static java.lang.String |
IDENTIFIER_PROPERTY
This is the property in a data file that specifies the URI of the Identifiable the data. |
static java.lang.String |
LANGUAGE_PROPERTY
This is the property in a data file that specifies the language of the data. |
static java.lang.String |
LICENSE_PROPERTY
This is the property in a data file that specifies the license of the data. |
static java.lang.String |
PUBLISHER_PROPERTY
This is the property in a data file that specifies the publisher of the data. |
static java.lang.String |
RELATION_PROPERTY
This is the property in a data file that specifies any relationships of the data. |
static java.lang.String |
REQUIRED_PROPERTY
This is the property in a data file that specifies any requirements of the data. |
static java.lang.String |
RIGHTS_PROPERTY
This is the property in a data file that specifies any rights associated with the data. |
static java.lang.String |
SERIALIZATION_DATE_RANGE_FORMAT_1_DATE
This is the format used to create date range strings used in file and folder names. |
static java.lang.String |
SERIALIZATION_DATE_RANGE_FORMAT_1_DATE_YEAR
This is the format used to create date range strings used in file and folder names. |
static java.lang.String |
SERIALIZATION_DATE_RANGE_FORMAT_2_DATES
This is the format used to create date range strings used in file and folder names. |
static java.lang.String |
SOURCE_PROPERTY
This is the property in a data file that specifies the source of the data. |
static java.lang.String |
SPATIAL_PROPERTY
This is the property in a spatial (GML) data file that specifies the file that contains the latitude/longitude data. |
static java.lang.String |
SUBJECT_PROPERTY
This is the property in a data file that specifies the subject of the data. |
static java.lang.String |
TITLE_PROPERTY
This is the property in a relationship data file that specifies the title of the relationship data. |
static java.lang.String |
TYPE_PROPERTY
This is the property in a data file that specifies the type of the data. |
static java.lang.String |
VALID_PROPERTY
This is the property in a data file that specifies the date range that the data is valid for. |
Method Summary | |
---|---|
void |
addAdminLevel(IdentifiableRecord.AdminLevel adminLevel)
|
void |
addAdminLevel(int adminLevel)
|
void |
addAdminLevels(java.util.List<IdentifiableRecord.AdminLevel> adminLevels)
Add a list of administration levels to the colleciton of administration levels |
int |
compareTo(IdentifiableRecord ir)
|
java.util.List<IdentifiableRecord.AdminLevel> |
getAdminLevels()
|
java.lang.String |
getAdminLevelsAsString(java.lang.String delmiter)
|
java.util.List<IdentifiableRecord.AdminLevel> |
getAdminLevelsMaxToMin()
|
DublinCore |
getDublinCore()
|
java.util.Date |
getEndDate()
|
Identifiable |
getIdentifiable()
|
IdentifiableRecord.AdminLevel |
getMaxAdminLevel()
|
IdentifiableRecord.AdminLevel |
getMinAdminLevel()
|
int |
getNumAdminLevels()
|
abstract int |
getNumEdges()
|
abstract int |
getNumLabels()
|
abstract int |
getNumModelDecorators()
|
abstract int |
getNumNodes()
|
abstract int |
getNumScenarioDecorators()
|
java.util.Date |
getStartDate()
|
boolean |
inDateRange(java.util.Date startDate,
java.util.Date endDate)
|
boolean |
isYounger(IdentifiableRecord ir)
|
void |
serialize(java.lang.String directory)
|
static void |
serializeIdentifiable(Identifiable identifiable,
org.eclipse.emf.common.util.URI fileURI)
Serialize an Identifiable |
void |
setDublinCore(DublinCore dublinCore)
|
void |
setEndDate(java.util.Date endDate)
|
void |
setIdentifiable(Identifiable identifiable)
|
void |
setStartDate(java.util.Date startDate)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String BIBLIOGRAPHIC_CITATION_PROPERTY
DublinCore.getBibliographicCitation()
,
Constant Field Valuespublic static final java.lang.String CONTRIBUTOR_PROPERTY
DublinCore.getContributor()
,
Constant Field Valuespublic static final java.lang.String COVERAGE_PROPERTY
DublinCore.getCoverage()
,
Constant Field Valuespublic static final java.lang.String CREATED_PROPERTY
DublinCore.getCreated()
,
Constant Field Valuespublic static final java.lang.String CREATOR_PROPERTY
DublinCore.getCreator()
,
Constant Field Valuespublic static final java.lang.String DATE_PROPERTY
DublinCore.getDate()
,
Constant Field Valuespublic static final java.lang.String DESCRIPTION_PROPERTY
DublinCore.getDescription()
,
Constant Field Valuespublic static final java.lang.String FORMAT_PROPERTY
DublinCore.getFormat()
,
Constant Field Valuespublic static final java.lang.String IDENTIFIER_PROPERTY
Identifiable
the data. Automatically generated if not specified.
Not typically used, nor recommended.
DublinCore.getIdentifier()
,
Constant Field Valuespublic static final java.lang.String LANGUAGE_PROPERTY
DublinCore.getLanguage()
,
Constant Field Valuespublic static final java.lang.String LICENSE_PROPERTY
DublinCore.getLicense()
,
Constant Field Valuespublic static final java.lang.String PUBLISHER_PROPERTY
DublinCore.getPublisher()
,
Constant Field Valuespublic static final java.lang.String RELATION_PROPERTY
DublinCore.getRelation()
,
Constant Field Valuespublic static final java.lang.String REQUIRED_PROPERTY
DublinCore.getRequired()
,
Constant Field Valuespublic static final java.lang.String RIGHTS_PROPERTY
DublinCore.getRights()
,
Constant Field Valuespublic static final java.lang.String SOURCE_PROPERTY
DublinCore.getSource()
,
Constant Field Valuespublic static final java.lang.String SPATIAL_PROPERTY
DublinCore.getSpatial()
,
Constant Field Valuespublic static final java.lang.String SUBJECT_PROPERTY
DublinCore.getSubject()
,
Constant Field Valuespublic static final java.lang.String TITLE_PROPERTY
DublinCore.getTitle()
,
Constant Field Valuespublic static final java.lang.String TYPE_PROPERTY
DublinCore.getType()
,
Constant Field Valuespublic static final java.lang.String VALID_PROPERTY
DublinCore.getValid()
,
Constant Field Valuespublic static java.lang.String identifiableURIPrefix
Identifiable
. If it is set to a non-null value, the created
Identifiable
s will have URI
s that begin with this
prefix. Typically it will begin with "platform:/plugin/....."
public static final java.lang.String SERIALIZATION_DATE_RANGE_FORMAT_2_DATES
public static final java.lang.String SERIALIZATION_DATE_RANGE_FORMAT_1_DATE
public static final java.lang.String SERIALIZATION_DATE_RANGE_FORMAT_1_DATE_YEAR
Method Detail |
---|
public final Identifiable getIdentifiable()
public final void setIdentifiable(Identifiable identifiable)
identifiable
- the identifiable to setpublic final java.util.Date getEndDate()
public final void setDublinCore(DublinCore dublinCore)
dublinCore
- public final void setEndDate(java.util.Date endDate)
endDate
- the endDate to setpublic final java.util.Date getStartDate()
public final void setStartDate(java.util.Date startDate)
startDate
- the startDate to setpublic boolean inDateRange(java.util.Date startDate, java.util.Date endDate)
startDate
- the start date of the date rangeendDate
- the end date of the date range
true
if the date range of this record overlaps the
test range, false
otherwise.public boolean isYounger(IdentifiableRecord ir)
ir
- the IdentifiableRecord
to test against
true
if this instance is "younger" than
ir
or if ir
is null
,
false
otherwise.public final void addAdminLevel(int adminLevel)
adminLevel
- the administration level to add to the recordpublic final void addAdminLevel(IdentifiableRecord.AdminLevel adminLevel)
adminLevel
- the administration level to add to the recordpublic final void addAdminLevels(java.util.List<IdentifiableRecord.AdminLevel> adminLevels)
adminLevels
- a list of administration levelspublic final java.util.List<IdentifiableRecord.AdminLevel> getAdminLevels()
public java.util.List<IdentifiableRecord.AdminLevel> getAdminLevelsMaxToMin()
public final int getNumAdminLevels()
public final IdentifiableRecord.AdminLevel getMaxAdminLevel()
public final IdentifiableRecord.AdminLevel getMinAdminLevel()
public final java.lang.String getAdminLevelsAsString(java.lang.String delmiter)
delmiter
- the string to place between the administration level integers
public abstract int getNumNodes()
Node
s in the Identifiable
public abstract int getNumEdges()
Edge
s in the Identifiable
public abstract int getNumLabels()
Label
s in the Identifiable
public abstract int getNumModelDecorators()
Decorator
s in the
Identifiable
public abstract int getNumScenarioDecorators()
Decorator
s in the
Identifiable
public final DublinCore getDublinCore()
public void serialize(java.lang.String directory)
directory
- this is the root directory that the
IdentifiableRecord
should serilize the
Identifiable
it creates. Typically, the file will be
in a sub-directory.public static void serializeIdentifiable(Identifiable identifiable, org.eclipse.emf.common.util.URI fileURI)
identifiable
- fileURI
- public int compareTo(IdentifiableRecord ir)
compareTo
in interface java.lang.Comparable<IdentifiableRecord>
ir
- the IdentifiableRecord
to compare against
IdentifiableRecord.AdminLevel.compareTo(org.eclipse.ohf.stem.internal.data.IdentifiableRecord.AdminLevel)
,
Comparable.compareTo(java.lang.Object)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |