Java tutorial
/** * (C) Copyright 2012 Chiral Behaviors, LLC. All Rights Reserved * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.chiralbehaviors.CoRE.agency; import static com.chiralbehaviors.CoRE.agency.Agency.FIND_ALL; import static com.chiralbehaviors.CoRE.agency.Agency.FIND_BY_NAME; import static com.chiralbehaviors.CoRE.agency.Agency.FIND_CLASSIFIED_ATTRIBUTE_AUTHORIZATIONS; import static com.chiralbehaviors.CoRE.agency.Agency.FIND_CLASSIFIED_ATTRIBUTE_VALUES; import static com.chiralbehaviors.CoRE.agency.Agency.FIND_GROUPED_ATTRIBUTE_AUTHORIZATIONS; import static com.chiralbehaviors.CoRE.agency.Agency.GET_ALL_PARENT_RELATIONSHIPS; import static com.chiralbehaviors.CoRE.agency.Agency.GET_CHILDREN; import static com.chiralbehaviors.CoRE.agency.Agency.GET_CHILD_RULES_BY_RELATIONSHIP; import static com.chiralbehaviors.CoRE.agency.Agency.UNLINKED; import static com.chiralbehaviors.CoRE.agency.AgencyAttribute.GET_ATTRIBUTE; import java.util.Collections; import java.util.List; import java.util.Set; import java.util.UUID; import javax.persistence.Entity; import javax.persistence.EntityManager; import javax.persistence.FetchType; import javax.persistence.NamedNativeQueries; import javax.persistence.NamedNativeQuery; import javax.persistence.NamedQueries; import javax.persistence.NamedQuery; import javax.persistence.OneToMany; import javax.persistence.Table; import javax.persistence.metamodel.SingularAttribute; import com.chiralbehaviors.CoRE.ExistentialRuleform; import com.chiralbehaviors.CoRE.Ruleform; import com.chiralbehaviors.CoRE.WellKnownObject.WellKnownAgency; import com.chiralbehaviors.CoRE.attribute.Attribute; import com.chiralbehaviors.CoRE.attribute.AttributeValue; import com.chiralbehaviors.CoRE.network.Relationship; import com.chiralbehaviors.CoRE.product.ProductNetwork; import com.chiralbehaviors.CoRE.workspace.WorkspaceAuthorization; import com.chiralbehaviors.CoRE.workspace.WorkspaceAuthorization_; import com.fasterxml.jackson.annotation.JsonIgnore; /** * An agency that can provide information, produce products, or perform work. * * Examples are people, lab groups, software, books, bank accounts, output files * of computational analyses, etc. * * @author hhildebrand * */ @NamedQueries({ @NamedQuery(name = FIND_ALL, query = "select a from Agency a"), @NamedQuery(name = FIND_BY_NAME, query = "select e from Agency e where e.name = :name"), @NamedQuery(name = FIND_CLASSIFIED_ATTRIBUTE_VALUES, query = "SELECT " + " attrValue " + "FROM " + " AgencyAttribute attrValue, " + " AgencyAttributeAuthorization auth, " + " AgencyNetwork network " + "WHERE " + " auth.authorizedAttribute = attrValue.attribute AND " + " network.relationship = auth.classification AND " + " network.child = auth.classifier AND" + " attrValue.agency = :ruleform AND " + " auth.classification = :classification AND " + " auth.classifier = :classifier "), @NamedQuery(name = FIND_CLASSIFIED_ATTRIBUTE_AUTHORIZATIONS, query = "select ra from AgencyAttributeAuthorization ra " + "WHERE ra.classification = :classification " + "AND ra.classifier = :classifier"), @NamedQuery(name = FIND_GROUPED_ATTRIBUTE_AUTHORIZATIONS, query = "select ra from AgencyAttributeAuthorization ra " + "WHERE ra.groupingAgency = :groupingAgency"), @NamedQuery(name = GET_CHILDREN, query = "SELECT n.child " + "FROM AgencyNetwork n " + "WHERE n.parent = :p " + "AND n.relationship = :r"), @NamedQuery(name = GET_ALL_PARENT_RELATIONSHIPS, query = "SELECT n " + "FROM AgencyNetwork n " + "WHERE n.child = :c"), @NamedQuery(name = GET_CHILD_RULES_BY_RELATIONSHIP, query = "SELECT n FROM AgencyNetwork n " + "WHERE n.parent = :agency " + "AND n.relationship IN :relationships " + "ORDER by n.parent.name, n.relationship.name, n.child.name") }) @NamedNativeQueries({ @NamedNativeQuery(name = UNLINKED, query = "SELECT unlinked.* " + "FROM agency AS unlinked " + "JOIN (" + " SELECT id " + " FROM agency " + " EXCEPT (" + " SELECT distinct(net.child) " + " FROM agency_network as net " + " WHERE net.parent = agency_id('Agency') " + " AND relationship = relationship_id('includes') " + " )" + ") AS linked ON unlinked.id = linked.id " + "WHERE unlinked.id != agency_id('Agency');", resultClass = Agency.class) }) @Entity @Table(name = "agency", schema = "ruleform") public class Agency extends ExistentialRuleform<Agency, AgencyNetwork> { public static final String AGENCY_ATTRIBUTES_BY_CLASSIFICATION = "agency.AgencyAttributesByClassification"; public static final String AUTHORIZED_AGENCY_ATTRIBUTES = "agency.authorizedAttributes"; public static final String FIND_ALL = "agency" + Ruleform.FIND_ALL_SUFFIX; public static final String FIND_BY_NAME = "agency" + FIND_BY_NAME_SUFFIX; public static final String FIND_CLASSIFIED_ATTRIBUTE_AUTHORIZATIONS = "agency" + FIND_CLASSIFIED_ATTRIBUTE_AUTHORIZATIONS_SUFFIX; public static final String FIND_CLASSIFIED_ATTRIBUTE_VALUES = "agency" + FIND_CLASSIFIED_ATTRIBUTE_VALUES_SUFFIX; public static final String FIND_GROUPED_ATTRIBUTE_AUTHORIZATIONS = "agency" + FIND_GROUPED_ATTRIBUTE_VALUES_SUFFIX; public static final String GET_ALL_PARENT_RELATIONSHIPS = "agency" + GET_ALL_PARENT_RELATIONSHIPS_SUFFIX; public static final String GET_CHILD_RULES_BY_RELATIONSHIP = "agency" + GET_CHILD_RULES_BY_RELATIONSHIP_SUFFIX; public static final String GET_CHILDREN = "agency" + GET_CHILDREN_SUFFIX; public static final String QUALIFIED_ENTITY_NETWORK_RULES = "agency.qualifiedEntityNetworkRules"; public static final String UNLINKED = "agency" + UNLINKED_SUFFIX; private static final long serialVersionUID = 1L; // bi-directional many-to-one association to AgencyAttribute @OneToMany(fetch = FetchType.LAZY, mappedBy = "agency") @JsonIgnore private Set<AgencyAttribute> attributes; // bi-directional many-to-one association to AgencyNetwork @OneToMany(fetch = FetchType.LAZY, mappedBy = "child") @JsonIgnore private Set<AgencyNetwork> networkByChild; // bi-directional many-to-one association to AgencyNetwork @OneToMany(fetch = FetchType.LAZY, mappedBy = "parent") @JsonIgnore private Set<AgencyNetwork> networkByParent; public Agency() { } /** * @param updatedBy */ public Agency(Agency updatedBy) { super(updatedBy); } /** * @param name */ public Agency(String name) { super(name); } /** * @param name * @param updatedBy */ public Agency(String name, Agency updatedBy) { super(name, updatedBy); } /** * @param name * @param description */ public Agency(String name, String description) { super(name, description); } /** * @param name * @param description * @param updatedBy */ public Agency(String name, String description, Agency updatedBy) { super(name, description, updatedBy); } /** * @param id */ public Agency(UUID id) { super(id); } public void addAttribute(AgencyAttribute attribute) { attribute.setAgency(this); attributes.add(attribute); } /* * (non-Javadoc) * * @see * com.chiralbehaviors.CoRE.Networked#addChildRelationship(com.chiralbehaviors * .CoRE.NetworkRuleform) */ @Override public void addChildRelationship(AgencyNetwork relationship) { relationship.setChild(this); networkByChild.add(relationship); } /* * (non-Javadoc) * * @see * com.chiralbehaviors.CoRE.Networked#addParentRelationship(com.chiralbehaviors * .CoRE.NetworkRuleform) */ @Override public void addParentRelationship(AgencyNetwork relationship) { relationship.setParent(this); networkByParent.add(relationship); } @Override public Agency clone() { Agency clone = (Agency) super.clone(); clone.networkByChild = null; clone.networkByParent = null; clone.attributes = null; return clone; } /* (non-Javadoc) * @see com.chiralbehaviors.CoRE.ExistentialRuleform#getAnyId() */ @Override public String getAnyId() { return WellKnownAgency.ANY.id(); } /** * Retrieves the unique AgencyAttribute rule for the given Agency and * Attribute. * * @param agency * The Agency the Attribute applies to * @param attribute * The Attribute of the Agency * @return the unique AgencyAttribute rule, or <code>null</code> if no such * rule exists */ public AgencyAttribute getAttribute(EntityManager em, Attribute attribute) { return em.createNamedQuery(GET_ATTRIBUTE, AgencyAttribute.class).setParameter("agency", this) .setParameter("attribute", attribute).getSingleResult(); } @SuppressWarnings("unchecked") @Override public Set<AgencyAttribute> getAttributes() { return attributes; } @Override @SuppressWarnings("unchecked") public Class<AgencyAttribute> getAttributeValueClass() { return AgencyAttribute.class; } /* (non-Javadoc) * @see com.chiralbehaviors.CoRE.ExistentialRuleform#getCopyId() */ @Override public String getCopyId() { return WellKnownAgency.COPY.id(); } @Override public Set<AgencyNetwork> getNetworkByChild() { if (networkByChild == null) { return Collections.emptySet(); } return networkByChild; } @Override public Set<AgencyNetwork> getNetworkByParent() { if (networkByParent == null) { return Collections.emptySet(); } return networkByParent; } /* (non-Javadoc) * @see com.chiralbehaviors.CoRE.ExistentialRuleform#getNetworkChildAttribute() */ @Override public SingularAttribute<AgencyNetwork, Agency> getNetworkChildAttribute() { return AgencyNetwork_.child; } /* (non-Javadoc) * @see com.chiralbehaviors.CoRE.ExistentialRuleform#getNetworkClass() */ @Override public Class<AgencyNetwork> getNetworkClass() { return AgencyNetwork.class; } /* (non-Javadoc) * @see com.chiralbehaviors.CoRE.ExistentialRuleform#getNetworkParentAttribute() */ @Override public SingularAttribute<AgencyNetwork, Agency> getNetworkParentAttribute() { return AgencyNetwork_.parent; } /* (non-Javadoc) * @see com.chiralbehaviors.CoRE.ExistentialRuleform#getNetworkWorkspaceAttribute() */ @Override public SingularAttribute<WorkspaceAuthorization, AgencyNetwork> getNetworkWorkspaceAuthAttribute() { return WorkspaceAuthorization_.agencyNetwork; } /* (non-Javadoc) * @see com.chiralbehaviors.CoRE.ExistentialRuleform#getNotApplicableId() */ @Override public String getNotApplicableId() { return WellKnownAgency.NOT_APPLICABLE.id(); } public List<ProductNetwork> getQualifiedEntityNetworkRules(EntityManager em) { return em.createNamedQuery(QUALIFIED_ENTITY_NETWORK_RULES, ProductNetwork.class) .setParameter("agency", this).getResultList(); } /* (non-Javadoc) * @see com.chiralbehaviors.CoRE.ExistentialRuleform#getSameId() */ @Override public String getSameId() { return WellKnownAgency.SAME.id(); } /* (non-Javadoc) * @see com.chiralbehaviors.CoRE.Ruleform#getWorkspaceAuthAttribute() */ @Override @JsonIgnore public SingularAttribute<WorkspaceAuthorization, Agency> getWorkspaceAuthAttribute() { return WorkspaceAuthorization_.agency; } /* (non-Javadoc) * @see com.chiralbehaviors.CoRE.ExistentialRuleform#isAny() */ @Override public boolean isAny() { return WellKnownAgency.ANY.id().equals(getId()); } /* (non-Javadoc) * @see com.chiralbehaviors.CoRE.ExistentialRuleform#isAnyOrSame() */ @Override public boolean isAnyOrSame() { return WellKnownAgency.ANY.id().equals(getId()) || WellKnownAgency.SAME.id().equals(getId()); } /* (non-Javadoc) * @see com.chiralbehaviors.CoRE.ExistentialRuleform#isCopy() */ @Override public boolean isCopy() { return WellKnownAgency.COPY.id().equals(getId()); } /* (non-Javadoc) * @see com.chiralbehaviors.CoRE.ExistentialRuleform#isNotApplicable() */ @Override public boolean isNotApplicable() { return WellKnownAgency.NOT_APPLICABLE.id().equals(getId()); } @Override public boolean isSame() { return WellKnownAgency.SAME.id().equals(getId()); } /* * (non-Javadoc) * * @see * com.chiralbehaviors.CoRE.network.Networked#link(com.chiralbehaviors.CoRE * .network.Relationship, com.chiralbehaviors.CoRE.network.Networked, * com.chiralbehaviors.CoRE.agency.Agency, javax.persistence.EntityManager) */ @Override public void link(Relationship r, Agency child, Agency updatedBy, Agency inverseSoftware, EntityManager em) { assert r != null : "Relationship cannot be null"; assert child != null; assert updatedBy != null; assert em != null; AgencyNetwork link = new AgencyNetwork(this, r, child, updatedBy); em.persist(link); AgencyNetwork inverse = new AgencyNetwork(child, r.getInverse(), this, inverseSoftware); em.persist(inverse); } @SuppressWarnings("unchecked") @Override public <A extends AttributeValue<Agency>> void setAttributes(Set<A> attributes) { this.attributes = (Set<AgencyAttribute>) attributes; } @Override public void setNetworkByChild(Set<AgencyNetwork> AgencyNetworks3) { networkByChild = AgencyNetworks3; } @Override public void setNetworkByParent(Set<AgencyNetwork> AgencyNetworks2) { networkByParent = AgencyNetworks2; } }