// ---------------------------------------------------------------------------
// dark-matter-data
// Copyright (c) 2010 dark-matter-data committers
// ---------------------------------------------------------------------------
// This program 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 3 of the License, or (at your
// option) any later version.
// This program 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.
// You should have received a copy of the GNU Lesser General Public License along
// with this program; if not, see <http://www.gnu.org/licenses/lgpl.html>.
// ---------------------------------------------------------------------------
package org.dmd.dmv.shared.generated.dmo;
// Generated from: org.dmd.dms.util.GenUtility.formatImports(GenUtility.java:391)
import java.io.Serializable; // Always required - (GenUtility.java:220)
import java.util.*; // Always required if we have any MV attributes - (GenUtility.java:215)
import org.dmd.dmc.DmcAttribute; // Any attributes - (GenUtility.java:236)
import org.dmd.dmc.DmcNamedObjectIF; // Named object - (GenUtility.java:371)
import org.dmd.dmc.DmcOmni; // Lazy resolution - (GenUtility.java:316)
import org.dmd.dmc.DmcSliceInfo; // Required for object slicing - (GenUtility.java:225)
import org.dmd.dmc.DmcValueException; // Any attributes - (GenUtility.java:237)
import org.dmd.dmc.types.RuleName; // Naming attribute type - (GenUtility.java:366)
import org.dmd.dms.generated.dmo.AttributeDefinitionDMO; // Type specific set/add - (GenUtility.java:303)
import org.dmd.dms.generated.dmo.MetaDMSAG; // Required for MODREC constructor - (GenUtility.java:224)
import org.dmd.dms.generated.dmo.RuleDataDMO; // Base class - (GenUtility.java:351)
import org.dmd.dms.generated.types.AttributeDefinitionREF; // Helper class - (GenUtility.java:331)
import org.dmd.dms.generated.types.DmcTypeAttributeDefinitionREFMV; // Reference type - (GenUtility.java:296)
import org.dmd.dms.generated.types.DmcTypeBooleanSV; // Required type - (GenUtility.java:324)
import org.dmd.dms.generated.types.DmcTypeModifierMV; // Required for MODREC constructor - (GenUtility.java:223)
import org.dmd.dms.generated.types.DmcTypeRuleNameSV; // Required type - (GenUtility.java:324)
import org.dmd.dms.generated.types.DmcTypeStringSV; // Required type - (GenUtility.java:324)
/**
* The OneOfTheseAttributesRequiredRule allows you to specify\n that one of
* the possible optional attributes specified must be present\n in the object
* being checked.\n <p/>\n If only one of the possibilities is allowed, you
* can specify the andOnlyOne\n flag and set it to true. In this case only
* one of the possibilities will be allowed.\n <p/>\n An example of this rule
* can be seen below.\n <pre>\n OneOfTheseAttributesRequiredRuleData\n
* ruleName dmvIncludeOrExclude\n ruleTitle At least one of the
* excludeThisAttribute or includeThisAttribute attributes must be
* specified.\n applyToClass CheckAttributesBasedOnValueRuleData\n
* onePossibility excludeThisAttribute\n
* onePossibility includeThisAttribute\n </pre>
* <P>
* Generated from the dmv schema at version 0.1
* <P>
* This code was auto-generated by the dmogenerator utility and shouldn't be alterred manually!
* Generated from: org.dmd.dms.util.DmoFormatter.dumpDMO(DmoFormatter.java:133)
*/
@SuppressWarnings("serial")
public class OneOfTheseAttributesRequiredRuleDataDMO extends RuleDataDMO implements DmcNamedObjectIF, Serializable {
public final static String constructionClassName = "OneOfTheseAttributesRequiredRuleData";
static {
}
public OneOfTheseAttributesRequiredRuleDataDMO() {
super("OneOfTheseAttributesRequiredRuleData");
}
protected OneOfTheseAttributesRequiredRuleDataDMO(String oc) {
super(oc);
}
@Override
public OneOfTheseAttributesRequiredRuleDataDMO getNew(){
OneOfTheseAttributesRequiredRuleDataDMO rc = new OneOfTheseAttributesRequiredRuleDataDMO();
return(rc);
}
@Override
public OneOfTheseAttributesRequiredRuleDataDMO getSlice(DmcSliceInfo info){
OneOfTheseAttributesRequiredRuleDataDMO rc = new OneOfTheseAttributesRequiredRuleDataDMO();
populateSlice(rc,info);
return(rc);
}
public OneOfTheseAttributesRequiredRuleDataDMO(DmcTypeModifierMV mods) {
super("OneOfTheseAttributesRequiredRuleData");
modrec(true);
setModifier(mods);
}
public OneOfTheseAttributesRequiredRuleDataDMO getModificationRecorder(){
OneOfTheseAttributesRequiredRuleDataDMO rc = new OneOfTheseAttributesRequiredRuleDataDMO();
rc.setRuleName(getRuleName());
rc.setModifier(new DmcTypeModifierMV(MetaDMSAG.__modify));
rc.modrec(true);
return(rc);
}
// org.dmd.dms.util.DmoFormatter.getAccessFunctions(DmoFormatter.java:744)
public RuleName getObjectName(){
DmcAttribute<?> name = get(MetaDMSAG.__ruleName);
if (name != null)
return((RuleName)name.getSV());
return(null);
}
// org.dmd.dms.util.DmoFormatter.getAccessFunctions(DmoFormatter.java:761)
public DmcAttribute<?> getObjectNameAttribute(){
DmcAttribute<?> name = get(MetaDMSAG.__ruleName);
return(name);
}
// org.dmd.dms.util.DmoFormatter.getAccessFunctions(DmoFormatter.java:768)
public boolean equals(Object obj){
if (obj instanceof OneOfTheseAttributesRequiredRuleDataDMO){
return( getObjectName().equals( ((OneOfTheseAttributesRequiredRuleDataDMO) obj).getObjectName()) );
}
return(false);
}
// org.dmd.dms.util.DmoFormatter.getAccessFunctions(DmoFormatter.java:776)
public int hashCode(){
RuleName objn = getObjectName();
if (objn == null)
return(0);
return(objn.hashCode());
}
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:774)
public String getDescription(){
DmcTypeStringSV attr = (DmcTypeStringSV) get(MetaDMSAG.__description);
if (attr == null)
return(null);
return(attr.getSV());
}
/**
* Sets description to the specified value.
* @param value String
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:814)
public void setDescription(String value) {
DmcAttribute<?> attr = get(MetaDMSAG.__description);
if (attr == null)
attr = new DmcTypeStringSV(MetaDMSAG.__description);
try{
attr.set(value);
set(MetaDMSAG.__description,attr);
}
catch(DmcValueException ex){
throw(new IllegalStateException("The type specific set() method shouldn't throw exceptions!",ex));
}
}
/**
* Sets description to the specified value.
* @param value A value compatible with DmcTypeStringSV
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:867)
public void setDescription(Object value) throws DmcValueException {
DmcTypeStringSV attr = (DmcTypeStringSV) get(MetaDMSAG.__description);
if (attr == null)
attr = new DmcTypeStringSV(MetaDMSAG.__description);
attr.set(value);
set(MetaDMSAG.__description,attr);
}
/**
* Removes the description attribute value.
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:887)
public void remDescription(){
rem(MetaDMSAG.__description);
}
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:774)
public Boolean isAndOnlyOne(){
DmcTypeBooleanSV attr = (DmcTypeBooleanSV) get(DmvDMSAG.__andOnlyOne);
if (attr == null)
return(false);
return(attr.getSV());
}
/**
* Sets andOnlyOne to the specified value.
* @param value Boolean
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:814)
public void setAndOnlyOne(Boolean value) {
DmcAttribute<?> attr = get(DmvDMSAG.__andOnlyOne);
if (attr == null)
attr = new DmcTypeBooleanSV(DmvDMSAG.__andOnlyOne);
try{
attr.set(value);
set(DmvDMSAG.__andOnlyOne,attr);
}
catch(DmcValueException ex){
throw(new IllegalStateException("The type specific set() method shouldn't throw exceptions!",ex));
}
}
/**
* Sets andOnlyOne to the specified value.
* @param value A value compatible with DmcTypeBooleanSV
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:867)
public void setAndOnlyOne(Object value) throws DmcValueException {
DmcTypeBooleanSV attr = (DmcTypeBooleanSV) get(DmvDMSAG.__andOnlyOne);
if (attr == null)
attr = new DmcTypeBooleanSV(DmvDMSAG.__andOnlyOne);
attr.set(value);
set(DmvDMSAG.__andOnlyOne,attr);
}
/**
* Removes the andOnlyOne attribute value.
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:887)
public void remAndOnlyOne(){
rem(DmvDMSAG.__andOnlyOne);
}
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:774)
public RuleName getRuleName(){
DmcTypeRuleNameSV attr = (DmcTypeRuleNameSV) get(MetaDMSAG.__ruleName);
if (attr == null)
return(null);
return(attr.getSV());
}
/**
* Sets ruleName to the specified value.
* @param value RuleName
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:814)
public void setRuleName(RuleName value) {
DmcAttribute<?> attr = get(MetaDMSAG.__ruleName);
if (attr == null)
attr = new DmcTypeRuleNameSV(MetaDMSAG.__ruleName);
try{
attr.set(value);
set(MetaDMSAG.__ruleName,attr);
}
catch(DmcValueException ex){
throw(new IllegalStateException("The type specific set() method shouldn't throw exceptions!",ex));
}
}
/**
* Sets ruleName to the specified value.
* @param value A value compatible with DmcTypeRuleNameSV
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:867)
public void setRuleName(Object value) throws DmcValueException {
DmcTypeRuleNameSV attr = (DmcTypeRuleNameSV) get(MetaDMSAG.__ruleName);
if (attr == null)
attr = new DmcTypeRuleNameSV(MetaDMSAG.__ruleName);
attr.set(value);
set(MetaDMSAG.__ruleName,attr);
}
/**
* Removes the ruleName attribute value.
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:887)
public void remRuleName(){
rem(MetaDMSAG.__ruleName);
}
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:774)
public String getRuleTitle(){
DmcTypeStringSV attr = (DmcTypeStringSV) get(MetaDMSAG.__ruleTitle);
if (attr == null)
return(null);
return(attr.getSV());
}
/**
* Sets ruleTitle to the specified value.
* @param value String
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:814)
public void setRuleTitle(String value) {
DmcAttribute<?> attr = get(MetaDMSAG.__ruleTitle);
if (attr == null)
attr = new DmcTypeStringSV(MetaDMSAG.__ruleTitle);
try{
attr.set(value);
set(MetaDMSAG.__ruleTitle,attr);
}
catch(DmcValueException ex){
throw(new IllegalStateException("The type specific set() method shouldn't throw exceptions!",ex));
}
}
/**
* Sets ruleTitle to the specified value.
* @param value A value compatible with DmcTypeStringSV
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:867)
public void setRuleTitle(Object value) throws DmcValueException {
DmcTypeStringSV attr = (DmcTypeStringSV) get(MetaDMSAG.__ruleTitle);
if (attr == null)
attr = new DmcTypeStringSV(MetaDMSAG.__ruleTitle);
attr.set(value);
set(MetaDMSAG.__ruleTitle,attr);
}
/**
* Removes the ruleTitle attribute value.
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:887)
public void remRuleTitle(){
rem(MetaDMSAG.__ruleTitle);
}
/**
* @return An Iterator of AttributeDefinitionDMO objects.
*/
@SuppressWarnings("unchecked")
// org.dmd.dms.util.GenUtility.formatMV(GenUtility.java:960)
public Iterator<AttributeDefinitionREF> getOnePossibility(){
DmcTypeAttributeDefinitionREFMV attr = (DmcTypeAttributeDefinitionREFMV) get(DmvDMSAG.__onePossibility);
if (attr == null)
return( ((List<AttributeDefinitionREF>) Collections.EMPTY_LIST).iterator() );
if (DmcOmni.instance().lazyResolution()){
if (attr.doLazyResolution(this)){
rem(attr.getAttributeInfo());
return( ((List<AttributeDefinitionREF>) Collections.EMPTY_LIST).iterator() );
}
}
return(attr.getMV());
}
/**
* @return An Iterator of AttributeDefinitionREFs without attempting lazy resolution (if it's turned on).
*/
@SuppressWarnings("unchecked")
// org.dmd.dms.util.GenUtility.formatMV(GenUtility.java:980)
public Iterator<AttributeDefinitionREF> getOnePossibilityREFs(){
DmcTypeAttributeDefinitionREFMV attr = (DmcTypeAttributeDefinitionREFMV) get(DmvDMSAG.__onePossibility);
if (attr == null)
return( ((List<AttributeDefinitionREF>) Collections.EMPTY_LIST).iterator() );
return(attr.getMV());
}
/**
* Adds another onePossibility to the specified value.
* @param value AttributeDefinition
*/
// org.dmd.dms.util.GenUtility.formatMV(GenUtility.java:994)
public DmcAttribute<?> addOnePossibility(AttributeDefinitionDMO value) {
DmcAttribute<?> attr = get(DmvDMSAG.__onePossibility);
if (attr == null)
attr = new DmcTypeAttributeDefinitionREFMV(DmvDMSAG.__onePossibility);
try{
setLastValue(attr.add(value));
add(DmvDMSAG.__onePossibility,attr);
}
catch(DmcValueException ex){
throw(new IllegalStateException("The type specific add() method shouldn't throw exceptions!",ex));
}
return(attr);
}
/**
* Adds another onePossibility value.
* @param value A value compatible with AttributeDefinition
*/
// org.dmd.dms.util.GenUtility.formatMV(GenUtility.java:1235)
public DmcAttribute<?> addOnePossibility(Object value) throws DmcValueException {
DmcAttribute<?> attr = get(DmvDMSAG.__onePossibility);
if (attr == null)
attr = new DmcTypeAttributeDefinitionREFMV(DmvDMSAG.__onePossibility);
setLastValue(attr.add(value));
add(DmvDMSAG.__onePossibility,attr);
return(attr);
}
/**
* Returns the number of values in onePossibility
*/
// org.dmd.dms.util.GenUtility.formatMV(GenUtility.java:1252)
public int getOnePossibilitySize(){
DmcAttribute<?> attr = get(DmvDMSAG.__onePossibility);
if (attr == null){
if (DmvDMSAG.__onePossibility.indexSize == 0)
return(0);
else
return(DmvDMSAG.__onePossibility.indexSize);
}
return(attr.getMVSize());
}
/**
* Deletes a onePossibility value.
* @param value The AttributeDefinition to be deleted from set of attribute values.
*/
// org.dmd.dms.util.GenUtility.formatMV(GenUtility.java:1291)
public DmcAttribute<?> delOnePossibility(Object value){
DmcAttribute<?> attr = get(DmvDMSAG.__onePossibility);
if ( (attr == null) && (getModifier()!= null))
delFromEmptyAttribute(new DmcTypeAttributeDefinitionREFMV(DmvDMSAG.__onePossibility), value);
else
attr = del(DmvDMSAG.__onePossibility, value);
return(attr);
}
/**
* Removes the onePossibility attribute value.
*/
// org.dmd.dms.util.GenUtility.formatMV(GenUtility.java:1345)
public void remOnePossibility(){
rem(DmvDMSAG.__onePossibility);
}
}