activefacts 0.6.0

data/examples/CQL/Death.cql

@@ -0,0 +1,16 @@
+vocabulary DeathAsUnary;
+
+/*
+ * Value Types
+ */
+CauseOfDeath is defined as VariableLengthText();
+PersonName is defined as VariableLengthText(40);
+
+/*
+ * Entity Types
+ */
+Person is identified by its Name;
+Death is where
+	Person is dead;
+Death was due to at most one CauseOfDeath;
+

data/examples/CQL/Genealogy.cql

@@ -0,0 +1,95 @@
+vocabulary Genealogy;
+
+/*
+ * Value Types
+ */
+Address is defined as VariableLengthText(128);
+Certificate is defined as VariableLengthText(64);
+Day is defined as UnsignedInteger(32) restricted to {1..31};
+Email is defined as VariableLengthText(64);
+EventID is defined as AutoCounter();
+EventLocation is defined as VariableLengthText(128);
+EventRoleName is defined as VariableLengthText() restricted to {'Subject', 'Father', 'Mother', 'Husband', 'Wife', 'Celebrant'};
+EventTypeID is defined as AutoCounter();
+EventTypeName is defined as VariableLengthText(16) restricted to {'Birth', 'Christening', 'Marriage', 'Divorce', 'Death', 'Burial'};
+Gender is defined as FixedLengthText(1) restricted to {'M', 'F'};
+Month is defined as UnsignedInteger(32) restricted to {1..12};
+Name is defined as VariableLengthText(128);
+Occupation is defined as VariableLengthText(128);
+Official is defined as VariableLengthText(64);
+PersonID is defined as AutoCounter();
+Picture is defined as PictureRawData(20);
+RoleID is defined as AutoCounter();
+SourceID is defined as AutoCounter();
+SourceName is defined as VariableLengthText(128);
+UserID is defined as AutoCounter();
+Year is defined as UnsignedInteger(32);
+
+/*
+ * Entity Types
+ */
+Event is identified by its ID;
+Event is certified by at most one Certificate;
+Event occurred at at most one EventLocation;
+Event was confirmed by at most one Official;
+
+EventDate is identified by min-Year and max-Year and Month and Day where
+	EventDate wasnt before at most one min-Year,
+	EventDate wasnt after at most one max-Year,
+	EventDate occurred in at most one Month,
+	EventDate occurred on at most one Day;
+Event occurred on at most one EventDate;
+
+EventType is identified by its ID;
+Event is of at most one EventType;
+EventType is called one EventTypeName,
+	EventTypeName is name of at most one EventType;
+
+Person is identified by its ID;
+Address is of Person,
+	Person lives at at most one Address;
+Email is of Person,
+	Person has at most one Email;
+Occupation is of Person,
+	Person is employed in at most one Occupation;
+Person is of at most one Gender;
+Person is called at most one family-Name,
+	family-Name is of Person;
+given-Name is name of Person,
+	Person is called at most one given-Name;
+preferred-Picture is of Person,
+	Person has at most one preferred-Picture;
+
+Role is identified by its ID;
+Role is called one EventRoleName,
+	EventRoleName is name of one Role;
+
+Source is identified by its ID;
+Source has one SourceName,
+	SourceName is of at most one Source;
+Participation is where
+	Person played Role in Event according to Source,
+	Person was involved in Event according to Source in Role,
+	Source claims Person played Role in Event;
+
+User is identified by its ID;
+Email is of User,
+	User has at most one Email;
+User provided Source,
+	Source was provided by one User;
+Friend is where
+	User is friend of other-User [symmetric];
+Friend is confirmed;
+
+/*
+ * Constraints:
+ */
+each Event occurs at least one time in
+	Person played Role in Event according to Source;
+each EventDate occurs at least one time in
+	EventDate wasnt before min-Year,
+	EventDate wasnt after max-Year,
+	EventDate occurred in Month,
+	EventDate occurred on Day;
+each Person occurs at least one time in
+	Person played Role in Event according to Source;

data/examples/CQL/Marriage.cql

@@ -0,0 +1,18 @@
+vocabulary Marriage;
+
+/*
+ * Value Types
+ */
+Name is defined as VariableLengthText();
+
+/*
+ * Entity Types
+ */
+Person is identified by given-Name and family-Name where
+	Person has one given-Name,
+	Person has one family-Name;
+
+Marriage is identified by Husband and Wife where
+	Marriage is by one husband-Person (as Husband),
+	Marriage is of one wife-Person (as Wife);
+

data/examples/CQL/Metamodel.cql

@@ -0,0 +1,238 @@
+vocabulary Metamodel;
+
+/*
+ * Value Types
+ */
+Adjective is defined as VariableLengthText(64);
+ConstraintId is defined as AutoCounter();
+Denominator is defined as UnsignedInteger(32);
+Enforcement is defined as VariableLengthText(16);
+Exponent is defined as SignedSmallInteger(32);
+FactId is defined as AutoCounter();
+FactTypeId is defined as AutoCounter();
+Frequency is defined as UnsignedInteger(32);
+InstanceId is defined as AutoCounter();
+Length is defined as UnsignedInteger(32);
+Name is defined as VariableLengthText(64);
+Numerator is defined as Decimal();
+Ordinal is defined as UnsignedSmallInteger(32);
+ReadingText is defined as VariableLengthText(256);
+RingType is defined as VariableLengthText();
+RoleSequenceId is defined as AutoCounter();
+Scale is defined as UnsignedInteger(32);
+UnitId is defined as AutoCounter();
+Value is defined as VariableLengthText(256);
+ValueRestrictionId is defined as AutoCounter();
+
+/*
+ * Entity Types
+ */
+Bound is identified by Value and Bound is inclusive where
+	Bound has one Value,
+	Value is of at least one Bound,
+	Bound is inclusive;
+
+Coefficient is identified by Numerator and Denominator and Coefficient is precise where
+	Coefficient has one Numerator,
+	Coefficient has one Denominator,
+	Coefficient is precise;
+
+Constraint is identified by its Id;
+Constraint requires at most one Enforcement,
+	Enforcement applies to Constraint;
+Name is of Constraint,
+	Constraint is called at most one Name;
+
+Fact is identified by its Id;
+
+FactType is identified by its Id;
+Fact is of one FactType;
+
+Instance is identified by its Id;
+Instance has at most one Value;
+
+PresenceConstraint is a kind of Constraint;
+PresenceConstraint has at most one max-Frequency;
+PresenceConstraint has at most one min-Frequency;
+PresenceConstraint is mandatory;
+PresenceConstraint is preferred identifier;
+
+Reading is identified by FactType and Ordinal where
+	FactType has at least one Reading,
+	Reading is for one FactType,
+	Reading is in at most one Ordinal position,
+	Ordinal reading for fact type is Reading;
+Reading has one ReadingText;
+
+RingConstraint is a kind of Constraint;
+RingConstraint is of one RingType;
+
+RoleSequence is identified by its Id;
+PresenceConstraint covers one RoleSequence;
+Reading is in one RoleSequence,
+	RoleSequence is for Reading;
+
+RoleValue is identified by Instance and Fact where
+	Instance plays RoleValue,
+	RoleValue is of one Instance,
+	RoleValue fulfils one Fact,
+	Fact includes at least one RoleValue;
+
+SetConstraint is a kind of Constraint;
+
+SubsetConstraint is a kind of SetConstraint;
+SubsetConstraint covers one subset-RoleSequence;
+SubsetConstraint covers one superset-RoleSequence;
+
+Unit is identified by its Id;
+Name is of Unit,
+	Unit is called one Name;
+Unit has at most one Coefficient;
+Unit is fundamental;
+UnitBasis is where
+	Unit (as DerivedUnit) is derived from base-Unit (as BaseUnit) [acyclic, intransitive];
+UnitBasis has at most one Exponent;
+
+ValueRange is identified by minimum-Bound and maximum-Bound where
+	ValueRange has at most one minimum-Bound,
+	ValueRange has at most one maximum-Bound;
+
+ValueRestriction is identified by its Id;
+AllowedRange is where
+	ValueRestriction allows at least one ValueRange;
+
+Vocabulary is identified by Name where
+	Vocabulary is called one Name;
+Vocabulary contains Constraint,
+	Constraint belongs to at most one Vocabulary;
+Import is where
+	Vocabulary imports imported-Vocabulary [acyclic];
+
+Feature is identified by Name and Vocabulary where
+	Feature is called one Name,
+	Feature belongs to at most one Vocabulary,
+	Vocabulary contains Feature;
+Correspondence is where
+	in Import imported-Feature corresponds to at most one local-Feature;
+
+Population is identified by Vocabulary and Name where
+	Vocabulary includes Population,
+	Population belongs to at most one Vocabulary,
+	Population has one Name,
+	Name is of Population;
+Population includes Fact,
+	Fact belongs to one Population;
+Population includes Instance,
+	Instance belongs to one Population;
+Population includes RoleValue,
+	RoleValue belongs to one Population;
+
+SetComparisonConstraint is a kind of SetConstraint;
+SetComparisonRoles is where
+	SetComparisonConstraint covers at least one RoleSequence;
+
+SetEqualityConstraint is a kind of SetComparisonConstraint;
+
+SetExclusionConstraint is a kind of SetComparisonConstraint;
+SetExclusionConstraint is mandatory;
+
+Alias is a kind of Feature;
+
+Concept is a kind of Feature;
+Concept is independent;
+Concept is personal;
+Instance is of one Concept;
+Role is where
+	FactType has Ordinal role played by Concept,
+	Concept plays role in FactType in Ordinal place,
+	Concept plays Ordinal role in FactType;
+Role is of RingConstraint,
+	RingConstraint has at most one Role;
+Role has at most one role-Name,
+	role-Name is name of at least one Role;
+Role has at most one role-ValueRestriction,
+	ValueRestriction applies to Role;
+RoleValue is of one Role;
+other-Role is of RingConstraint,
+	RingConstraint has at most one other-Role;
+RoleRef is where
+	RoleSequence in Ordinal position includes at most one Role,
+	Role is in RoleSequence in at most one Ordinal place,
+	RoleSequence includes Role in Ordinal place,
+	Role has Ordinal place in RoleSequence;
+RoleRef has at most one leading-Adjective;
+RoleRef has at most one trailing-Adjective;
+JoinPath is where
+	RoleRef has Ordinal (as JoinStep) path;
+JoinPath traverses at most one Concept,
+	Concept is traversed by JoinPath;
+JoinPath has one input-Role;
+JoinPath has one output-Role;
+
+EntityType is a kind of Concept;
+EntityType nests at most one FactType,
+	FactType is nested as at most one EntityType;
+TypeInheritance is a kind of FactType identified by Subtype and Supertype where
+	EntityType (as Subtype) is subtype of super-EntityType (as Supertype) [acyclic],
+	Supertype is supertype of Subtype;
+TypeInheritance provides identification;
+
+ValueType is a kind of Concept;
+ValueType has at most one Length,
+	Length is of ValueType;
+ValueType has at most one Scale,
+	Scale is of ValueType;
+ValueType is of at most one Unit;
+ValueType has at most one ValueRestriction;
+ValueType is subtype of at most one super-ValueType (as Supertype) [acyclic],
+	Supertype is supertype of ValueType;
+
+/*
+ * Constraints:
+ */
+for each Concept exactly one of these holds:
+	EntityType is a subtype of Concept,
+	ValueType is a subtype of Concept;
+for each Constraint exactly one of these holds:
+	PresenceConstraint is a subtype of Constraint,
+	SetConstraint is a subtype of Constraint,
+	RingConstraint is a subtype of Constraint;
+for each Feature exactly one of these holds:
+	Concept is a subtype of Feature,
+	Alias is a subtype of Feature;
+Instance plays RoleValue and Instance is of Concept
+	if and only if
+	RoleValue is of Role and FactType has Ordinal role played by Concept;
+RoleValue fulfils Fact and Fact is of FactType
+	if and only if
+	RoleValue is of Role and FactType has Ordinal role played by Concept;
+for each SetComparisonConstraint exactly one of these holds:
+	SetExclusionConstraint is a subtype of SetComparisonConstraint,
+	SetEqualityConstraint is a subtype of SetComparisonConstraint;
+for each SetConstraint exactly one of these holds:
+	SetComparisonConstraint is a subtype of SetConstraint,
+	SubsetConstraint is a subtype of SetConstraint;
+for each Unit exactly one of these holds:
+	Unit is fundamental,
+	that Unit is derived from some base-Unit;
+PresenceConstraint is preferred identifier
+	only if PresenceConstraint has max-Frequency;
+ValueType has Scale
+	only if ValueType has Length;
+each combination EntityType, TypeInheritance occurs at most one time in
+	EntityType is subtype of super-EntityType,
+	TypeInheritance provides identification;
+each FactType occurs at least one time in
+	FactType has Ordinal role played by Concept;
+each combination Name, Vocabulary occurs at most one time in
+	Name is of Constraint,
+	Vocabulary contains Constraint;
+each PresenceConstraint occurs at least one time in
+	PresenceConstraint has min-Frequency,
+	PresenceConstraint has max-Frequency,
+	PresenceConstraint is mandatory;
+each RoleSequence occurs at least one time in
+	RoleSequence in Ordinal position includes Role;
+each ValueRange occurs at least one time in
+	ValueRange has minimum-Bound,
+	ValueRange has maximum-Bound;

data/examples/CQL/MultiInheritance.cql

@@ -0,0 +1,19 @@
+vocabulary MultiInheritance;
+
+/*
+ * Value Types
+ */
+EmployeeID is defined as AutoCounter();
+PersonName is defined as VariableLengthText();
+
+/*
+ * Entity Types
+ */
+Person is identified by its Name;
+
+Australian is a kind of Person;
+
+Employee is a kind of Person identified by its ID;
+
+AustralianEmployee is a kind of Employee, Australian;
+

data/examples/CQL/OilSupply.cql

@@ -0,0 +1,47 @@
+vocabulary OilSupply;
+
+/*
+ * Value Types
+ */
+Cost is defined as Money();
+MonthCode is defined as FixedLengthText();
+ProductName is defined as VariableLengthText();
+Quantity is defined as UnsignedInteger(32);
+RefineryName is defined as VariableLengthText(80);
+RegionName is defined as VariableLengthText();
+Season is defined as VariableLengthText(6) restricted to {'Spring', 'Summer', 'Autumn', 'Winter'};
+TransportMethod is defined as VariableLengthText() restricted to {'Rail', 'Road', 'Sea'};
+YearNr is defined as SignedInteger(32);
+
+/*
+ * Entity Types
+ */
+Month is identified by its Code;
+Month is in one Season;
+
+Product is identified by its Name;
+AcceptableSubstitutes is where
+	Product may be substituted by alternate-Product in Season [acyclic, intransitive],
+	alternate-Product is an acceptable substitute for Product in Season;
+
+Refinery is identified by its Name;
+
+Region is identified by its Name;
+TransportRoute is where
+	TransportMethod transportation is available from Refinery to Region,
+	TransportMethod transportation is available to Region from Refinery;
+TransportRoute incurs at most one Cost per kl;
+
+Year is identified by its Nr;
+
+SupplyPeriod is identified by Month and Year where
+	SupplyPeriod is in one Month,
+	SupplyPeriod is in one Year;
+ProductionForecast is where
+	Refinery forecasts production of Product in SupplyPeriod;
+RegionalDemand is where
+	Region will need Product in SupplyPeriod;
+ProductionForecast predicts at most one Cost;
+ProductionForecast is for one Quantity;
+RegionalDemand is for at most one Quantity;
+

data/examples/CQL/Orienteering.cql

@@ -0,0 +1,108 @@
+vocabulary Orienteering;
+
+/*
+ * Value Types
+ */
+Accessibility is defined as FixedLengthText(1) restricted to {'A'..'D'};
+ClubCode is defined as VariableLengthText(6);
+ClubName is defined as VariableLengthText(32);
+ControlNumber is defined as UnsignedInteger(32) restricted to {1..1000};
+Course is defined as VariableLengthText(16) restricted to {'A'..'E', 'PW'};
+EntryID is defined as AutoCounter();
+EventID is defined as AutoCounter();
+EventName is defined as VariableLengthText(50);
+FamilyName is defined as VariableLengthText(48);
+Gender is defined as FixedLengthText(1) restricted to {'M', 'F'};
+GivenName is defined as VariableLengthText(48);
+Location is defined as VariableLengthText(200);
+MapID is defined as AutoCounter();
+MapName is defined as VariableLengthText(80);
+Number is defined as UnsignedInteger(32) restricted to {1..100};
+PersonID is defined as AutoCounter();
+Placing is defined as UnsignedInteger(32);
+PointValue is defined as UnsignedInteger(32);
+PostCode is defined as UnsignedInteger(32);
+PunchID is defined as AutoCounter();
+Score is defined as SignedInteger(32);
+ScoringMethod is defined as VariableLengthText(32) restricted to {'Score', 'Scatter', 'Special'};
+SeriesID is defined as AutoCounter();
+SeriesName is defined as VariableLengthText(40);
+StartTime is defined as DateAndTime();
+Time is defined as DateAndTime();
+Year is defined as UnsignedInteger(32) restricted to {1900..3000};
+
+/*
+ * Entity Types
+ */
+Club is identified by its Code;
+ClubName is name of at most one Club,
+	Club is called one ClubName;
+
+Event is identified by its ID;
+Club runs Event,
+	Event is run by one Club;
+Event is called at most one EventName,
+	EventName is name of at most one Event;
+Event has at most one Number;
+Event is held on one StartTime;
+Event starts at one start-Location,
+	Location is where Event starts;
+EventControl is where
+	Event includes at least one ControlNumber;
+EventScoringMethod is where
+	ScoringMethod is used for Course of Event,
+	Course of Event uses at most one ScoringMethod;
+EventControl has at most one PointValue;
+
+Map is identified by its ID;
+Club (as Owner) owns Map,
+	Map is owned by one Owner;
+Map has at most one Accessibility;
+Map is map for Event,
+	Event uses one Map;
+Map has one MapName,
+	MapName is of at most one Map;
+
+Person is identified by its ID;
+Person is member of at most one Club;
+Person has one FamilyName,
+	FamilyName is of Person;
+Person is of at most one Gender;
+Person has one GivenName,
+	GivenName is name of Person;
+Person has at most one PostCode;
+Person was born in at most one birth-Year;
+Entry is identified by its ID where
+	Person entered Course of Event,
+	Person entered Event in at most one Course;
+Entry received at most one Score;
+Entry finished in at most one finish-Placing;
+
+Punch is identified by its ID;
+PunchPlacement is where
+	Punch is placed at EventControl;
+Visit is where
+	Punch was visited by Entry at Time;
+
+Series is identified by its ID;
+Event is in at most one Series;
+Series has one SeriesName (as Name),
+	Name is of at most one Series;
+
+/*
+ * Constraints:
+ */
+Event is in Series
+	if and only if
+	Event has Number;
+each Event occurs at least one time in
+	Event is called EventName,
+	Event is in Series;
+each EventControl occurs at least one time in
+	Punch is placed at EventControl;
+each combination GivenName, FamilyName occurs at most one time in
+	Person has GivenName,
+	Person has FamilyName;
+each combination Series, Number occurs at most one time in
+	Event is in Series,
+	Event has Number;