Eksamen 2016

  Begge disse bør være markert som private, siden de ikke skal være tilgjengelig utenfor klassen. label bør også være final, siden den ikke skal kunne endres.

Her er det viktig å returnere et eksisterende Gender-objekt, ved å sammenligne argumentet med label-verdien i de to konstantene MALE og FEMALE. En kan også bruke switch, som i Java 8 virker med String-objekter. valueOf ligner på Integer.valueOf og Double.valueOf og må være static, siden det er unaturlig og unødvendig å kalle den på en eksisterende instans.

public static Gender valueOf(String label) {
   if (MALE.label.equals(label)) {
      return MALE;
   } else if (FEMALE.label.equals(label)) {
      return FEMALE;
   }
   return null;
}

Her er litt av poenget at en må ha en konstruktør som setter navnet og utelate set-metoder for name, mother og father.

private final String name;
private Gender gender = null;
private Person father, mother;

public Person(String name) {
   this.name = name;
}


public String getName() {
   return name;
}

public Gender getGender() {
   return gender;
}

public void setGender(Gender gender) {
   this.gender = gender;
}

public Person getMother() {
   return mother;
}

public Person getFather() {
   return father;
}

Her må en ha riktig deklarasjon av feltet (helst Collection, sekundært List), og huske å initialisere feltet. getChildren må passe på å returnere en ny Collection, så annen kode ikke får tilgang til interne data. En må ta høyde for at gender kan være null. En kan gjerne bruke Stream-teknikken.

private Collection<Person> children = new ArrayList<>();

public int getChildCount() {
   return children.size();
}

public boolean hasChild(Person child) {
   return children.contains(child);
}

// alternativ

public boolean hasChild(Person child) {
   return child.getFather() == this || child.getMother() == this;
}

public Collection<Person> getChildren(Gender gender) {
   Collection<Person> result = new ArrayList<>();
   for (Person child : children) {
      if (gender == null || child.getGender() == gender) {
         result.add(child);
      }
   }
   return result;
}

Hvis en klasse implementerer Iterable, så kan referanser til denne klassen brukes på høyresiden av kolonet i en for-each-løkke, f.eks. for (Person child : person). Se også getChildren-koden over.

Et (litt mindre relevant, og ikke påkrevd) alternativ er Iterable.forEach(Consumer<Person>). Dette er en såkalt default-metode (kom ikke frem i vedlegget) som en får gratis når en implementerer Iterable.

@Override
public Iterator<Person> iterator() {
   return children.iterator();
}

Her er det vanskelig å komme med en fasit, men poenget er å vurdere oppførselen til egen kode for tilfeller en ikke har tenkt på. En bør kunne beskrive de to tilfellene og forstå hva som faktisk vil skje i egen kode.

I det første tilfellet skifter far først kjønn, før hun på ny får lagt til barnet. Koden over vil fjerne koblingen til og fra den eksisterende moren, og så etablere en tilsvarende kobling med den nye moren, som også er den eksisterende faren. Hun ender opp med å være far og mor til samme barn, og dette barnet vil finnes dobbelt opp i children-lista. Her ville nok det riktigste være at den eksisterende far-koblingen også ble fjernet, før mor-barn-koblingen ble etablert.

I det andre tilfellet så legges faren til som barn av eget barn, som gir en sirkulær struktur. Dette bør det være en sjekk for, for mange algoritmer vil da ende opp i evig løkke.

Samme krav til members-lista (navnet er ikke nøye) som til Person.children. En trenger ikke sørge for at alle barn av personer som legges til, også legges til. Dette kan en anta gjøres utenfra. Må bruke equals for å sammenligne String-objekter.

private Collection<Person> members = new ArrayList<>();

public void addMember(Person person) {
   members.add(person);
}

public Person findMember(String name) {
   for (Person person : members) {
      if (person.getName().equals(name)) {
         return person;
      }
   }
   return null;
}

Det viktigste med save-metoden er at den først skriver ut alle linjer av type 1, altså den person-informasjonen som er nødvendig for å lage Person-objektene før foreldre-barn-koblingen etableres. Vi velger å lage en PrintWriter rundt OutputStream-en vi får inn, for å muliggjøre bruke av print og println. Vi kunne brukt en PrintStream, men en Writer anbefales jo for tekst (trekker ikke for bruk av PrintStream). Så skrives alle linjene av type 2 ut. Derfor blir det to iterasjoner over alle medlemmene. Navn får anførselstegn (”) rundt (merk måten ” inkluderes i en String). Her sjekkes det om en person har barn (kan gjøre på mange måter), så det ikke blir linjer med en forelder, men det er strengt tatt ikke definert som et krav (det står ”sequence of names”, og en sekvens kan jo ha bare ett element). Hvis en har linjer med bare én forelder, så er det viktig at load-metoden håndterer det riktig. Det er vanlig at den som setter opp en OutputStream også lukker den, og derfor avslutter vi ikke med pw.close(). Vi avslutter imidlertid med pw.flush() for å sikre at all vår output sendes ut med en gang (trekker ikke for manglende bruk av close()/flush()).

load-metoden klassifiserer hver linje som en av de tre typene ved å først sjekke om den er tom eller starter med # (type 3) og så sjekker om første token i en linje er en gyldig Gender (type 1). Ellers er den av type 2. Her gjøres det ingen sjekk på om formatet er korrekt, f.eks. om et barn i en linje av type 2 faktisk er registrert som familiemedlem. Det er kanskje litt uklart hvorvidt og evt. hvordan tokenize håndterer #, så det er greit at den brukes før en sjekker for linjer av type 3.

Unntak håndteres ikke av metodene, så de må deklareres med throws. Det er naturlig å bruke IOException, for den utløses ved bruk av InputStream og OutputStream. En kunne brukt Exception or å markere (at vi er klar over) at det er mye som kan gå galt, men det anbefales å bruke den mest spesifikke typen. Vi kunne fanget opp og ignorert unntak, men det kan lett maskere feil vi ønsker å avdekke.

private void outputQuotedName(Person person, PrintWriter pw) {
   pw.print("\"" + person.getName() + "\"");       
}

public void save(OutputStream out) throws IOException {
   PrintWriter pw = new PrintWriter(out);
   pw.println("# all persons");
   for (Person person : members) {
      pw.print(person.getGender());
      pw.print(" ");
      outputQuotedName(person, pw);
      pw.println();
   }
   pw.println();
   pw.println("# all mother/father-child relations");
   for (Person person : members) {
      if (person.iterator().hasNext()) {
         outputQuotedName(person, pw);
         for (Person child : person) {
            pw.print(" ");
            outputQuotedName(child, pw);
         }
         pw.println();
      }
   }
   pw.flush();
}

public void load(InputStream in) throws IOException {
   Scanner scanner = new Scanner(in);
   while (scanner.hasNextLine()) {
      String line = scanner.nextLine();
      if (line.trim().length() == 0 || line.startsWith("#")) {
         continue;
      }
      List<String> tokens = tokenize(line);
      Gender gender = Gender.valueOf(tokens.get(0));
      if (gender != null) {
         // type 1 line
         Person person = new Person(tokens.get(1));
         person.setGender(gender);
         addMember(person);
      } else {
         // type 2 line
         Person person = findMember(tokens.get(0));
         for (int i = 1; i < tokens.size(); i++) {
            Person child = findMember(tokens.get(i));
            person.addChild(child);
         }
      }
   }
   scanner.close();
}

Objektdiagram kan tegnes på mange måter. Det viktigste er å ha med navn med klassen til objektene, attributter med enkle verdier (inkl. String) inni boksen og piler med attributtnavn for referansetyper. Identitet er ikke så viktig her. Family- og Gender-objektene fantes fra før.

Parent-klassen er enklest. En må få med både mor og far, og unngå å legge til null-verdier. I Sister-klassen er det laget en hjelpemetode kalt addChildren, som legger alle jente-barn av en gitt Person til en liste og unngår duplikater. Denne kalles med både mor og far til personen en ønsker å finne søstrene til. Merk at dette også vil legge til halvsøstre. Til slutt fjernes personen selv, for hun er jo ikke sin egen søster (subtilt poeng, jeg vet)!

public class Sister implements Relation {


   private void addChildren(Person person, Collection<Person> result) {
      if (person != null) {
         for (Person child : person) {
            if (child.getGender() == Gender.FEMALE && (! result.contains(child))) {
                result.add(child);
            }
         }
      }
   }

   @Override
   public Collection<Person> getRelativesOf(Person person) {
          Collection<Person> result = new ArrayList<>();
          addChildren(person.getFather(), result);
          addChildren(person.getMother(), result);
          result.remove(person);
          return result;
    }
}

public class Parent implements Relation {


   @Override
   public Collection<Person> getRelativesOf(Person person) {
      Collection<Person> result = new ArrayList<>();
      if (person.getMother() != null) {
         result.add(person.getMother());
      }
      if (person.getFather() != null) {
         result.add(person.getFather());
      }
      return result;
   }
}

Poenget her er å gjøre som beskrevet i oppgaven, å bruke rel2 på resultatet av å bruke rel1. Her sjekkes det ikke for duplikater (som det sjelden er behov for med relasjoner av denne typen). Dette er delegeringsteknikken i praksis, som kjennetegnes ved at et delegerende objekt, som skal utføre en oppgave, ber en eller flere delegater om å utføre (omtrent) samme oppgave, for så å kombinere resultatene. Her delegeres det til rel1 og rel2, som implementerer samme grensesnitt som Relation2. Det er også en form for komposisjon, men det er ikke pensum.

public class Relation2 implements Relation {


   public Relation2(Relation rel1, Relation rel2) {
      this.rel1 = rel1;
      this.rel2 = rel2;
   }

   private final Relation rel1, rel2;

   @Override
   public Collection<Person> getRelativesOf(Person person) {
      Collection<Person> result1 = rel1.getRelativesOf(person);
      Collection<Person> result2 = new ArrayList<>();
      for (Person person1 : result1) {
         result2.addAll(rel2.getRelativesOf(person1));
      }
      return result2;
   }
}

Oldeforelder-relasjonen kan defineres som forelder av forelder av forelder. Dette kan realiseres vha. to (nivåer av) Relation2-objekter (altså uten å skrive en ny klasse!):

Relation parent = new Parent();
Relation grandParent = new Relation2(parent, parent);
Relation grandGrandParent = new Relation2(grandParent, parent);

En kan lage Sibling-klassen med utgangspunkt i Sister-klassen, og legge til et gender-felt som brukes for å plukke ut og legge til barn med den gitte kjønnet (eller begge, hvis gender er null).Her gjøres det i addChildren-metoden, som må endres. Sister- og Brother-klassene sørger for å initialisere gender-feltet med riktig verdi, evt. vha. en Sister-konstruktør.

En annen variant er å la Sister og Brother filtrere superklassen sitt resultat på kjønn, men dette er ikke like god utnyttelse av arv (kunne i prinsippet brukt delegering). 

Her brukes uttrykksvarianten av funksjonssyntaksen, siden resultatet beregnes enkelt ved å bruke getChildren-metoden. Først har en argumentlista, så en ”pil” og så uttrykket som beregner resultatet. Dette omformes til en implementasjon av Relation med uttrykket som innholdet i getRelationOf-metoden.

Relation daughter = (person) -> person.getChildren(Gender.FEMALE);